// Copyright (c) 2005-2009 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:

// Tests CBaBackupSessionWrapper APIs and observers for backup server.

// 

//

/**

 @file

 @test

 @internalComponent - Internal Symbian test code

*/

#include <eikenv.h>

#include <coecntrl.h>

#include <basched.h>

#include <babackup.h>

#include <eikappui.h>

#include <eikdef.h>

#include <eikapp.h>

#include <eikdoc.h>

#include <techview/eikon.hrh>

#include <techview/eiktxlbx.h>

#include <techview/eiktxlbm.h>

#include <techview/eikchlst.h>

#include <techview/eikclb.h>

#include <techview/eikclbd.h>

#include <techview/eikdialg.h>

#include <techview/eikcapc.h>

#include <apgwgnam.h>

#include <apgtask.h>

#include <apgcli.h>

#include <eikcoctl.rsg>

#include <techview/eikchkbx.h>

#include <eikmsg.h>

#include <techview/eikhopbt.h>

#include <uiklafgt/eikcore.rsg>

#include <ecom/ecom.h>

#include "tbackup.hrh"

#include <tbackup.rsg>

#include "tbackup.h"

_LIT(KBackupFile1,"foo1");

_LIT(KBackupFile2,"foo2");

_LIT(KBackupFile3,"foo3");

_LIT(KObserverStr, "Observer %d:");

_LIT(KBackupOpMsg, "Backup Operation running");

_LIT(KRegistrationDlgTitle, "Register and DeRegister Observers");

_LIT(KTBackupResourceFilePath, "z:\\system\\test\\tbackup\\tbackup.rsc");

/**********************************************

 	CBackupDialogBase

************************************************/

CBackupDialogBase::CBackupDialogBase(CDesCArray& aFiles,TOperationGranularity& aGranularity,TDes& aFileName)

	: iFiles(aFiles), iGranularity(aGranularity), iFileName(aFileName)

/**

   Constructor

 */

	{}

/**

   Auxiliary Function for all Test Cases

   This method is an override from CEikDialog.It performs pre-layout dialog

   initialisation.

 */

void CBackupDialogBase::PreLayoutDynInitL()

	{

	SetHorOptionButListCurrentSet(EDlgBackupCloseOpButList,EDlgBackupCloseAll);

	CEikChoiceList* list=static_cast<CEikChoiceList*>(Control(EDlgBackupFileList));

	list->SetArrayExternalOwnership(ETrue);

	list->SetArrayL(&iFiles);

	UpdateFileListDimmedState();

	}

/**

   Auxiliary Function for all Test Cases

   This method is an override from CEikDialog. Handles dialog button press 'All'

   and 'File' to select a single file or all files to be closed by the dialog.

 */

TBool CBackupDialogBase::OkToExitL(TInt /*aButtonId*/)

	{

	if (HorOptionButListCurrentSet(EDlgBackupCloseOpButList)==EDlgBackupCloseAll)

		{

		iGranularity=EAll;

		}

	else

		{

		iGranularity=ESingleFile;

		const CEikChoiceList* list=static_cast<CEikChoiceList*>(Control(EDlgBackupFileList));

		iFileName=iFiles[list->CurrentItem()];

		}

	return ETrue;

	}

/**

   Auxiliary Function for all Test Cases

   This method is an override from CEikDialog. This function is called when a

   control event of type EEventStateChanged is received by the dialog from one

   of its component controls. 

 */

void CBackupDialogBase::HandleControlStateChangeL(TInt aControlId)

	{

	if (aControlId==EDlgBackupCloseOpButList)

		{

		UpdateFileListDimmedState();

		}

	}

/**

   Auxiliary Function for all Test Cases

   This method is an override from CEikDialog. This method dims and deactivates

   the file choice list on the dialog.

 */

void CBackupDialogBase::UpdateFileListDimmedState()

	{

	const TBool dimFileList=(HorOptionButListCurrentSet(EDlgBackupCloseOpButList)==EDlgBackupCloseAll);

	const CEikChoiceList* list=static_cast<CEikChoiceList*>(Control(EDlgBackupFileList));

	const TBool fileListDimmed=list->IsDimmed();

	if (dimFileList!=fileListDimmed)

		{

		SetLineDimmedNow(EDlgBackupFileList,dimFileList);

		}

	}

/**********************************************

 	CBackupCloseDialog

************************************************/

/**

  Auxiliary function for TestCaseID tbackup-CmdCloseL

  This method initialises and launches the backup close dialog.

 */

TBool CBackupCloseDialog::RunDlgLD(CDesCArray& aFiles,CBackupDialogBase::TOperationGranularity& aGranularity,

										TDes& aFileName,MBackupObserver::TFileLockFlags& aFlag)

	{ // static

	CBackupCloseDialog* dlg=new(ELeave) CBackupCloseDialog(aFiles,aGranularity,aFileName,aFlag);

	return dlg->ExecuteLD(R_TBACKUP_FILE_OPTIONS);

	}

CBackupCloseDialog::CBackupCloseDialog(CDesCArray& aFiles,CBackupDialogBase::TOperationGranularity& aGranularity,

										TDes& aFileName,MBackupObserver::TFileLockFlags& aFlag)

	: CBackupDialogBase(aFiles,aGranularity,aFileName), iFileFlag(aFlag)

/**

   Constructor

 */

	{

	}

/**

   Auxiliary function for TestCaseID tbackup-CmdCloseL

   This method is an override from CEikDialog.It performs pre-layout dialog

   initialisation.

 */

void CBackupCloseDialog::PreLayoutDynInitL()

	{

	SetHorOptionButListCurrentSet(EDlgBackupFlagOpButList,EDlgBackupReadOnly);

	CBackupDialogBase::PreLayoutDynInitL();

	}

/**

   Auxiliary function for TestCaseID tbackup-CmdCloseL

   This method is an override from CEikDialog. It is used to specify 'Read only' or

   'No access' file locks while CloseAll() & CloseFileL() APIs are invoked.

 */

TBool CBackupCloseDialog::OkToExitL(TInt aButtonId)

	{

	if (HorOptionButListCurrentSet(EDlgBackupFlagOpButList)==EDlgBackupReadOnly)

		{

		iFileFlag=MBackupObserver::EReleaseLockReadOnly;

		}

	else

		{

		iFileFlag=MBackupObserver::EReleaseLockNoAccess;

		}

	return CBackupDialogBase::OkToExitL(aButtonId);

	}

/**********************************************

 	CBackupRestartDialog

************************************************/

/**

   Auxiliary function for TestCaseID tbackup-CmdRestartL

   This method initialises and launches the backup restart dialog.

 */

TBool CBackupRestartDialog::RunDlgLD(CDesCArray& aFiles,CBackupDialogBase::TOperationGranularity& aGranularity,

										TDes& aFileName)

	{ // static

	CBackupRestartDialog* dlg=new(ELeave) CBackupRestartDialog(aFiles,aGranularity,aFileName);

	return dlg->ExecuteLD(R_TBACKUP_FILE_OPTIONS);

	}

CBackupRestartDialog::CBackupRestartDialog(CDesCArray& aFiles,CBackupDialogBase::TOperationGranularity& aGranularity,

											TDes& aFileName)

	: CBackupDialogBase(aFiles,aGranularity,aFileName)

/**

   Constructor

 */

	{}

/**

   Auxiliary function for TestCaseID tbackup-CmdRestartL

   This method is an override from CEikDialog.It performs pre-layout dialog

   initialisation.

 */

void CBackupRestartDialog::PreLayoutDynInitL()

	{

	SetTitleL(R_TBACKUP_RESTART_DLG_TITLE);

	TBuf<20> text;

	iCoeEnv->ReadResource(text,R_TBACKUP_RESTART_OPTION_TITLE);

	CEikLabel* caption=Line(EDlgBackupCloseOpButList)->iCaption;

	caption->SetTextL(text);

	DeleteLine(EDlgBackupFlagOpButList);

	CBackupDialogBase::PreLayoutDynInitL();

	}

/**********************************************

 	CBackupFileObserver

************************************************/

CBackupFileObserver::TBackupFile::TBackupFile(const TDesC& aFileName,TFileLock aLockState)

	: iFileName(aFileName), iLockState(aLockState)

/**

   Constructor

 */

	{}

/**

   Auxiliary function for all test cases

   This method is part of two-phase construction of CBackupFileObserver.The

   method is called by CTBackupAppUi::CreateFileObserversL() to construct new

   client to backup server.

 */

CBackupFileObserver* CBackupFileObserver::NewLC()

	{ // static

	CBackupFileObserver* self=new(ELeave) CBackupFileObserver();

	CleanupStack::PushL(self);

	self->ConstructL();

	return self;

	}

CBackupFileObserver::~CBackupFileObserver()

/**

   Destructor

 */

	{

	const TInt count=iBackupArray.Count();

	for (TInt ii=count-1;ii>=0;ii--)

		{

		const TBackupFile& backup=iBackupArray[ii];

		RemoveFile(backup.iFileName);

		}

	iBackupArray.Close();

	delete iBackupSession;

	}

struct SFileAddCleanup

	{

	CBackupFileObserver* iFileObserver;

	TFileName iFileName;

	};

/**

   Auxiliary function for all Test Cases

   This method is cleanup operation invoked by the pop and destroy action

   resulting from a subsequent call to CleanupStack::PopAndDestroy() to

   perform clean up of SFileAddCleanup object.

 */

LOCAL_C void CleanupAddFile(TAny* aPtr)

	{

	SFileAddCleanup* cleanup=REINTERPRET_CAST(SFileAddCleanup*,aPtr);

	cleanup->iFileObserver->RemoveFile(cleanup->iFileName);

	}

/**

   Auxiliary function for all Test Cases

   This method registers a file with the backup server.

 */

void CBackupFileObserver::AddFileL(const TDesC& aFileName)

	{

	TBackupFile backup(aFileName,ELocked);

	User::LeaveIfError(iBackupArray.Append(backup));

	SFileAddCleanup cleanup;

	cleanup.iFileObserver=this;

	cleanup.iFileName=aFileName;

	CleanupStack::PushL(TCleanupItem(CleanupAddFile,&cleanup));

	iBackupSession->RegisterFileL(aFileName,*this);

	CleanupStack::Pop(); // CleanupAddFile

	}

/**

   Auxiliary function for all Test Cases

   This method is invoked by cleanup method CleanupAddFile() to remove the

   registration of a file with the backup server.

 */

void CBackupFileObserver::RemoveFile(const TDesC& aFileName)

	{

	const TInt index=Find(aFileName);

	if (index!=KErrNotFound)

		{

		iBackupSession->DeregisterFile(aFileName);

		iBackupArray.Remove(index);

		iBackupArray.Compress();

		}

	}

/**

   Auxiliary function for all Test Cases

   This method returns the array iBackupArray which holds the list of files

   registered with the observer.

 */

const RArray<CBackupFileObserver::TBackupFile>& CBackupFileObserver::BackupArray() const

	{

	return iBackupArray;

	}

CBackupFileObserver::CBackupFileObserver()

/**

   Constructor

 */

	{}

/**

   Auxiliary function for all test cases

   This method is part of Two-phase construction of CBackupFileObserver.The

   method constructs a new client to the backup server .

 */

void CBackupFileObserver::ConstructL()

	{

	iBackupSession=CBaBackupSessionWrapper::NewL();

	}

/**

   Auxiliary function for all Test Cases

   This method attempts to find the file specifed within the iBackupArray

   and returns its index within the array if found. Otherwise KErrNotFound is

   returned.

 */

TInt CBackupFileObserver::Find(const TDesC& aFileName) const

	{

	TInt index=KErrNotFound;

	const TInt count=iBackupArray.Count();

	for (TInt ii=0;ii<count;ii++)

		{

		const TBackupFile& backup=iBackupArray[ii];

		if (backup.iFileName==aFileName)

			{

			index=ii;

			break;

			}

		}

	return index;

	}

/**

   Auxiliary function for all Test Cases

   This method finds the file specifed within the iBackupArray and changes its

   file lock as specified by aFlag parameter.

 */

void CBackupFileObserver::ChangeFileLockL(const TDesC& aFileName,TFileLockFlags aFlags)

	{

	const TInt index=Find(aFileName);

	if (index==KErrNotFound)

		{

		User::Invariant();

		}

	iBackupArray[index].iLockState=(CBackupFileObserver::TFileLock)aFlags;

	}

/**********************************************

  	CBackupOpeartionObserver

************************************************/

/**

   Auxiliary function for all Test cases

   This method returns ETrue if the observer is registered with the backup

   server.

 */

inline TBool CBackupOpeartionObserver::IsRegistered() const

	{

	return iRegistered;

	}

/**

   Auxiliary function for TestCaseID tbackup-AutoUpdateBackupObserverRegistrationL

   The method sets the observer as registered with the back up server.

 */

inline void CBackupOpeartionObserver::SetRegistered(TBool aIsRegistered)

	{

	iRegistered = aIsRegistered;

	}

/**

   Auxiliary function for all Test cases

   This method creates an observer for backup operation.

 */

CBackupOpeartionObserver* CBackupOpeartionObserver::NewL()

	{

	CBackupOpeartionObserver* self=new(ELeave) CBackupOpeartionObserver();

	return self;

	}

CBackupOpeartionObserver::CBackupOpeartionObserver()

/**

   Constructor

 */

	{

	}

/**

   Auxiliary function for TestCaseID tbackup-AutoUpdateBackupOperationStateL

   This method is an override from MBackupOperationObserver and is invoked when a

   backup or restore operation either starts or ends.

 */

void CBackupOpeartionObserver::HandleBackupOperationEventL(const TBackupOperationAttributes& aBackupOperationAttributes)

	{

	MBackupOperationObserver::TOperationType operation = aBackupOperationAttributes.iOperation;

	switch (operation)

		{

		case MBackupOperationObserver::EStart:

			User::InfoPrint(_L("Backup Operation Start"));

			break;

		case MBackupOperationObserver::EEnd:

			User::InfoPrint(_L("Backup Operation End"));

			break;

		case MBackupOperationObserver::EAbort:

			User::InfoPrint(_L("Backup Operation Abort"));

			break;

		case MBackupOperationObserver::ENone:

		default:

			break;

		}

	iBackupOperationAttributes = aBackupOperationAttributes;

	}