sl@0: // Copyright (c) 2004-2009 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: // Implementation of RABClientSession class.
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @file
sl@0: */
sl@0: 
sl@0: #include "abclientsession.h"
sl@0: #include "abclientserver.h"
sl@0: #include "panic.h"
sl@0: 
sl@0: namespace conn
sl@0: 	{
sl@0: 	HBufC8* RABClientSession::GetDataFromServerLC(const TInt aDataLength, 
sl@0: 		TABCallbackCommands aCallbackRequestingData)
sl@0: 	/**
sl@0: 	Following a callback call to the Active Backup Callback Handler, this method requests the data 
sl@0: 	from the server. aDataLength will have been supplied by the original callback call from the server 
sl@0: 	and all that remains is to make a synchronous call to get it copied over
sl@0: 	
sl@0: 	@param aDataLength The length of the data that will be received
sl@0: 	@param aCallbackRequestingData The callback enum identifying the callback requesting this data
sl@0: 	@return Pointer to a heap allocated descriptor containing data from the server
sl@0: 	*/
sl@0: 		{
sl@0: 		HBufC8* pReturnedData = HBufC8::NewLC(aDataLength);
sl@0: 		
sl@0: 		TPtr8 returnedData(pReturnedData->Des());
sl@0: 		
sl@0: 		// Request that the server returns the promised data to the client for the specified callback 
sl@0: 		User::LeaveIfError(SendReceive(EABMsgGetDataSync, 
sl@0: 			TIpcArgs(static_cast<TInt>(aCallbackRequestingData), &returnedData)));
sl@0: 		
sl@0: 		return pReturnedData;
sl@0: 		}
sl@0: 
sl@0: 	HBufC8* RABClientSession::GetDataFromServerLC(const TInt aDataLength, 
sl@0: 		TABCallbackCommands aCallbackRequestingData, TDriveNumber& aDriveNum)
sl@0: 	/**
sl@0: 	Following a callback call to the Active Backup Callback Handler, this method requests the data 
sl@0: 	from the server. aDataLength will have been supplied by the original callback call from the server 
sl@0: 	and all that remains is to make a synchronous call to get it copied over. This should only be called 
sl@0: 	from a ReceiveSnapshot callback
sl@0: 	
sl@0: 	@param aDataLength The length of the data that will be received
sl@0: 	@param aCallbackRequestingData The callback enum identifying the callback requesting this data
sl@0: 	@param aDriveNum The drive number
sl@0: 
sl@0: 	@return Pointer to a heap allocated descriptor containing data from the server
sl@0: 	*/
sl@0: 		{
sl@0: 		TPckg<TDriveNumber> drvPkg(aDriveNum);
sl@0: 		HBufC8* pReturnedData = HBufC8::NewLC(aDataLength);
sl@0: 		
sl@0: 		TPtr8 returnedData(pReturnedData->Des());
sl@0: 		
sl@0: 		// Request that the server returns the promised data to the client for the specified callback 
sl@0: 		User::LeaveIfError(SendReceive(EABMsgGetDataSync, 
sl@0: 			TIpcArgs(static_cast<TInt>(aCallbackRequestingData), &returnedData)));
sl@0: 		
sl@0: 		// Request that the server returns the drive number to the client for the specified callback 
sl@0: 		TInt retVal = SendReceive(EABMsgGetDriveNumForSuppliedSnapshot);
sl@0: 		
sl@0: 		User::LeaveIfError(retVal);
sl@0: 		
sl@0: 		aDriveNum = static_cast<TDriveNumber>(retVal);
sl@0: 		
sl@0: 		return pReturnedData;
sl@0: 		}
sl@0: 
sl@0: 	void RABClientSession::SendDataLengthToServerL(TDesC8& aData, TBool aFinished, 
sl@0: 		TABCallbackCommands aCallbackSendingData)
sl@0: 	/**
sl@0: 	Send the length and finished flag back to the server. Limitations of IPC mean that we can only send 
sl@0: 	fixed size data to the server, hence the length and finished flag are sent first so that the server 
sl@0: 	may allocate the appropriate amount of space prior to the response containing the data
sl@0: 	
sl@0: 	@param aData 		Descriptor containing the data to send back to the server. Only the length of this 
sl@0: 						is sent in this message
sl@0: 	@param aFinished 	Flag indicating that this is the last transfer from the client to server. If EFalse, 
sl@0: 						the server must call the callback again
sl@0: 	@param aCallbackSendingData This 
sl@0: 	*/
sl@0: 		{
sl@0: 		// Make the synchronous call back to the server telling it to allocate a big enough buffer
sl@0: 		// to handle the data transfer that will follow this 
sl@0: 		User::LeaveIfError(SendReceive(EABMsgSendDataLength, TIpcArgs(
sl@0: 										static_cast<TInt>(aData.Size()),
sl@0: 										static_cast<TInt>(aFinished),
sl@0: 										static_cast<TInt>(aCallbackSendingData))));
sl@0: 		}
sl@0: 
sl@0: 	void RABClientSession::PrimeServerForCallbackL(TPckgBuf<TABCallbackCommands>& aCallback, 
sl@0: 		TPckgBuf<TInt>& aArg1, TPckgBuf<TInt>& aArg2, TRequestStatus& aStatus)
sl@0: 	/** 
sl@0: 	Send an async message to the server so that it can call us back when it's ready to make callback's
sl@0: 	
sl@0: 	@param aCallback This modifiable package buf is set by the server to indicate which callback to call
sl@0: 	@param aArg1 This is the first argument for the callback, set by the server
sl@0: 	@param aArg2 This is the second argument for the callback, set by the server
sl@0: 	@param aStatus The status 
sl@0: 	*/
sl@0: 		{
sl@0: 		SendReceive(EABMsgPrimeForCallback, TIpcArgs(&aCallback, &aArg1, &aArg2), aStatus);
sl@0: 		}
sl@0: 		
sl@0: 	void RABClientSession::PrimeServerForCallbackWithResponseL(TPckgBuf<TABCallbackCommands>& aCallback, 
sl@0: 		TPckgBuf<TInt>& aArg1, TPckgBuf<TInt>& aArg2, TInt aResult, TRequestStatus& aStatus)
sl@0: 	/** 
sl@0: 	Send an async message to the server so that it can call us back when it's ready to make callback's.
sl@0: 	This call also returns a result from the previous callback for the server to respond to/return to the PC etc.
sl@0: 	
sl@0: 	@param aCallback This modifiable package buf is set by the server to indicate which callback to call
sl@0: 	@param aArg1 This is the first argument for the callback, set by the server
sl@0: 	@param aArg2 This is the second argument for the callback, set by the server
sl@0: 	@param aResult The return value of the previous callback to pass back to the server
sl@0: 	@param aStatus The status 
sl@0: 	*/
sl@0: 		{
sl@0: 		SendReceive(EABMsgPrimeForCallbackAndResponse, TIpcArgs(&aCallback, &aArg1, &aArg2, aResult), aStatus);
sl@0: 		}
sl@0: 
sl@0: 	void RABClientSession::PrimeServerForCallbackWithResponseL(TPckgBuf<TABCallbackCommands>& aCallback, 
sl@0: 		TPckgBuf<TInt>& aArg1, TPckgBuf<TInt>& aArg2, TDesC8& aResult, TRequestStatus& aStatus)
sl@0: 	/** 
sl@0: 	Send an async message to the server so that it can call us back when it's ready to make callback's.
sl@0: 	This call also returns a result from the previous callback for the server to respond to/return to the PC etc.
sl@0: 	
sl@0: 	@param aCallback This modifiable package buf is set by the server to indicate which callback to call
sl@0: 	@param aArg1 This is the first argument for the callback, set by the server
sl@0: 	@param aArg2 This is the second argument for the callback, set by the server
sl@0: 	@param aResult Data to send back to the server
sl@0: 	@param aStatus The status 
sl@0: 	
sl@0: 	@pre A call to SendDataLengthToServerL must have preceeded this call so that the server may prepare to receive data
sl@0: 	*/
sl@0: 		{
sl@0: 		SendReceive(EABMsgPrimeForCallbackAndResponseDes, TIpcArgs(&aCallback, &aArg1, &aArg2, &aResult), aStatus);
sl@0: 		}
sl@0: 
sl@0: 	void RABClientSession::PropagateLeave(TInt aLeaveCode)		
sl@0: 	/**
sl@0: 	Send a synchronous IPC message to the server indicating that a leave has ocurred whilst executing a callback
sl@0: 	
sl@0: 	@param aLeaveCode The code to leave back to the server with
sl@0: 	@param aStatus The status 
sl@0: 	*/
sl@0: 		{
sl@0: 		SendReceive(EABMsgPropagateLeave, TIpcArgs(aLeaveCode));
sl@0: 		}
sl@0: 		
sl@0:     void RABClientSession::BURModeInfoL(TDriveList& aDriveList, TBURPartType& aBackupType, TBackupIncType& aIncBackupType)
sl@0:     /**
sl@0:     This method returns the type(s) of backup / restore operation currently active
sl@0: 
sl@0:     @param aDriveList list of drives involved in backup and restore
sl@0:     @param aBackupType enumerated type indicating whether a backup or restore
sl@0:     is in progress and whether full or partial.
sl@0:     @param aIncBackupType enumerated type indicating whetherr a backup is base
sl@0:     or incremental.
sl@0:     */
sl@0: 		{
sl@0: 		TPckg<TBURPartType> partTypePkg(aBackupType);
sl@0: 		TPckg<TBackupIncType> incTypePkg(aIncBackupType);
sl@0: 		
sl@0: 		User::LeaveIfError(SendReceive(EABMsgBURModeInfo, TIpcArgs(&aDriveList, &partTypePkg, &incTypePkg)));
sl@0: 		}
sl@0: 
sl@0: 
sl@0:     TBool RABClientSession::DoesPartialBURAffectMeL()
sl@0:     /**
sl@0:     This method can be called when a partial backup or restore is active and will indicate
sl@0:     whether the calling process is expected to take part.  If a full backup or restore is 
sl@0:     active then this method will return ETrue for all data owners.  If no backup or restore
sl@0:     is active then this method will return EFalse for all data owners.
sl@0: 
sl@0:     @return ETrue if the calling data owner is involved in the current backup or restore
sl@0:     operation.
sl@0:     */
sl@0: 		{
sl@0: 		TPckgBuf<TBool> partialAffectsMe;
sl@0: 		
sl@0: 		User::LeaveIfError(SendReceive(EABMsgDoesPartialAffectMe, TIpcArgs(&partialAffectsMe)));
sl@0: 		
sl@0: 		return partialAffectsMe();
sl@0: 		}
sl@0: 
sl@0: 
sl@0:     void RABClientSession::ConfirmReadyForBURL(TInt aErrorCode)
sl@0:     /**
sl@0:     This method is called to indicate to the Secure Backup Server that the data owner is ready
sl@0:     to participate in backup or restore.  The data owner must call this method to indicate
sl@0:     readiness or the Secure Backup Server will not request or supply backup data.
sl@0: 
sl@0:     N.B. The Secure Backup Server will supply snapshot data (if relevant) before a data 
sl@0:     owner indicates readiness as it assumes that the data owner requires snapshot data in
sl@0:     order to prepare for a backp or restore.
sl@0: 
sl@0:     @param aErrorCode this should be set to KErrNone when the client is ready for
sl@0:     backup or restore. If it is set to any other value then it indicates that the client
sl@0:     cannot continue with the backup or restore and the error code will be supplied to
sl@0:     the remote backup client.
sl@0:     */
sl@0: 		{
sl@0: 		User::LeaveIfError(SendReceive(EABMsgConfirmReadyForBUR, TIpcArgs(aErrorCode)));
sl@0: 		}
sl@0: 		
sl@0: 	void RABClientSession::CancelServerCallbackL()
sl@0: 	/**
sl@0: 	Inform the server that it can no longer call callbacks on the client
sl@0: 	*/
sl@0: 		{
sl@0: 		User::LeaveIfError(SendReceive(EABMsgClosingDownCallback));
sl@0: 		}
sl@0: 		
sl@0: 	RABClientSession::RABClientSession()
sl@0: 	/** Class constructor. */
sl@0: 		{
sl@0: 		}
sl@0: 
sl@0: 	void RABClientSession::Close()
sl@0: 	/** Closes the Secure Backup Engine handle. */
sl@0: 		{
sl@0: 		RSessionBase::Close();
sl@0: 		}
sl@0: 
sl@0: 	TInt RABClientSession::Connect()
sl@0: 	/** Connects the handle to the Secure Backup Engine.
sl@0: 
sl@0: 	@return KErrNone if successful, KErrCouldNotConnect otherwise
sl@0: 	*/
sl@0: 		{
sl@0: 		TInt nRetry = KABRetryCount;
sl@0: 		TInt nRet = KErrNotFound;
sl@0: 
sl@0: 		while(nRetry > 0 && nRet != KErrNone)
sl@0: 			{
sl@0: 		    const TSecurityPolicy policy(static_cast<TSecureId>(KSBServerUID3));
sl@0: 			nRet = CreateSession(KABServerName, Version(), KABASyncMessageSlots, EIpcSession_Unsharable,&policy);
sl@0: 			if(nRet == KErrNotFound || nRet == KErrServerTerminated)
sl@0: 				{
sl@0: 				StartServer();
sl@0: 				}
sl@0: 			nRetry--;
sl@0: 			}
sl@0: 
sl@0: 		return nRet;
sl@0: 		}
sl@0: 
sl@0: 	TVersion RABClientSession::Version() const
sl@0: 	/** Returns the version of this API
sl@0: 
sl@0: 	@return The version of this API
sl@0: 	*/
sl@0: 		{
sl@0: 	    return TVersion (KABMajorVersionNumber,
sl@0: 							KABMinorVersionNumber,
sl@0: 							KABBuildVersionNumber);
sl@0: 	  	}
sl@0: 
sl@0: 	//
sl@0: 	// Server startup code
sl@0: 	TInt RABClientSession::StartServer()
sl@0: 	/** Start the server as a thread on WINS or a process on ARM.
sl@0: 	
sl@0: 	Called by Connect when the kernel is unable to create a session
sl@0: 	with the AB server (if the process hosting it is not running).
sl@0: 
sl@0: 	@return Standard Symbian OS code from RProcess/RThread create.
sl@0: 	*/
sl@0: 		{
sl@0: 		//
sl@0: 		// Servers UID
sl@0: 		const TUidType serverUid(KNullUid, KNullUid, KSBServerUID3);
sl@0: 		
sl@0: 	
sl@0: 		RProcess server;
sl@0:     	TInt nRet=server.Create(KSBImageName,KNullDesC,serverUid);
sl@0:     	if (nRet != KErrNone)
sl@0:     	    {
sl@0:     		return nRet;
sl@0:     		}
sl@0:     		
sl@0:     	TRequestStatus stat;
sl@0:     	server.Rendezvous(stat);
sl@0:     	if (stat != KRequestPending)
sl@0:     	{
sl@0:     		server.Kill(0);
sl@0:     	}
sl@0:     	else
sl@0:     	{
sl@0:     		server.Resume();
sl@0:     	}
sl@0:     	User::WaitForRequest(stat);
sl@0:     	return (server.ExitType() == EExitPanic) ? KErrGeneral : stat.Int();
sl@0: 		
sl@0: 		}
sl@0: 
sl@0: 
sl@0: 
sl@0: 	} // conn namespace