// 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 the License "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:

// f32\sfile\sf_plugin_util.cpp

// 

//

#include "sf_std.h"

/**

Utility function to obtain the file name from a file share object

@param	aFileShare		A pointer to the file share

@param	aName			A reference to the descriptor to contain the file name

*/

LOCAL_C void NameFromShare(CFileShare* aFileShare, TDes& aName)

	{

	if(aFileShare)

		{

		CFileCB& theFile = aFileShare->File();

		aName = _L("?:");

		aName[0] = TText('A' + theFile.Drive().DriveNumber());

		aName.Append(theFile.FileName());

		}

	}

/**

Utility function for obtaining info on file duplicate or adopt requests.

@param	aRequest		File access request

@param	aDriveNumber	The drive number

@param	aHandle			sub-session handle

@param	aAtt			File attributes

@param	aSize			FileSize

@param	aName			Name of the file

@return File modification time in format of TTime

*/

LOCAL_C TInt FileDuplicateAdoptVars(CFsRequest* aRequest, TInt& aDriveNumber, TInt& aHandle, TInt& aAtt, TInt& aSize, TDes& aName, TTime& aTime)

	{

	__ASSERT_ALWAYS(aRequest->Operation()->Function()==EFsFileDuplicate || aRequest->Operation()->Function()==EFsFileAdopt,Fault(EBaseRequestMessage));

	aDriveNumber = aRequest->DriveNumber();

	aHandle = aRequest->Message().Int0();

	CFileShare* share = (CFileShare*)aRequest->ScratchValue();

	if(share == NULL)

		return(KErrBadHandle);

	NameFromShare(share, aName);

	CFileCB& theFile = share->File();

	aAtt  = theFile.Att();

	aSize = theFile.Size();

	aTime = theFile.Modified();

	return(KErrNone);

	}

/**

Utility function for obtaining info on file open requests.  

@param	aRequest	File open request

@param	aMode		File Open Mode

@param	aHandle		File handle

@param	aName		File's name

*/

LOCAL_C TInt FileOpenVar(CFsRequest* aRequest, TUint32& aMode, TInt& aHandle, TDes& aName)

	{

	__ASSERT_ALWAYS(aRequest->Operation()->Function()==EFsFileOpen,Fault(EBaseRequestMessage));

	aMode = aRequest->Message().Int1();

	TPtr8 handle((TUint8*)&aHandle,sizeof(TInt));

	TRAPD(err,aRequest->ReadL(KMsgPtr3,handle));

	if(err != KErrNone)

		{

 		handle=0;

		return(err);

		}

	aName = aRequest->Src().FullName();

	return(KErrNone);

	}

/**

Utility function for obtaining info on file Create/Replace requests.

@param	aRequest	File Create/Replace request

@param	aMode		File Create/Replace Mode

@param	aName		File's name

*/

LOCAL_C TInt FileCreateReplaceVar(CFsRequest* aRequest, TUint32& aMode, TDes& aName)

	{

	__ASSERT_ALWAYS(aRequest->Operation()->Function()==EFsFileCreate || aRequest->Operation()->Function()==EFsFileReplace,Fault(EBaseRequestMessage));

	aMode = aRequest->Message().Int1();

	aName = aRequest->Src().FullName();

	return(KErrNone);

	}

/**

Utility function for obtaining info on file temp requests.  

@param	aRequest	File temp request

@param	aMode		File Mode

@param	aName		File's name

@param  aPath		File's path

*/

LOCAL_C TInt FileTempVar(CFsRequest* aRequest, TUint32& aMode, TDes& aName,TDes& aPath)

	{

	__ASSERT_ALWAYS(aRequest->Operation()->Function()==EFsFileTemp,Fault(EBaseRequestMessage));

	aMode = aRequest->Message().Int1();

	aPath = aRequest->Src().FullName();

	TInt nameLen = aRequest->GetDesLength(KMsgPtr2);

	if(nameLen < 0 || nameLen > KMaxFileName)

		{

	    return KErrBadName;

		}

	TRAPD(err, aRequest->ReadL(KMsgPtr2, aName));

	return(err);

	}

/**

Utility function for obtaining info on file read/write requests.  

@param	aRequest	File access request

@param	aLen		The length of file for access

@param	aPos		Position of first byte to be accessed

@param	aName		File name

@return Client's buffer 

*/

LOCAL_C TInt FileAccessVars(CFsRequest* aRequest, TInt& aLen, TInt& aPos, TDes& aName, const TAny*& aPtr)

	{

	__ASSERT_ALWAYS(aRequest->Operation()->Function()==EFsFileRead || aRequest->Operation()->Function()==EFsFileWrite,Fault(EBaseRequestMessage));

	TMsgOperation& currentOperation = ((CFsMessageRequest*) aRequest)->CurrentOperation();

	aLen = currentOperation.iReadWriteArgs.iLength;

	aPos = (TInt) currentOperation.iReadWriteArgs.iPos;

	CFileShare* share = (CFileShare*)aRequest->ScratchValue();

	if(share == NULL)

		return(KErrBadHandle);

	NameFromShare(share, aName);

	if (aPos == KCurrentPosition64)

		{

		aPos = (TInt)share->iPos;

		}

	aPtr = (TAny*)aRequest->Message().Ptr0();

	return(KErrNone);

	}

/**

Utility function for obtaining info on file lock/unlcok requests.  

@param	aRequest	File lock request

@param	aLen		The length of file 

@param	aPos		Position of first byte 

@param	aName		File name

*/

LOCAL_C TInt FileLockVars(CFsRequest* aRequest, TInt& aLen, TInt& aPos, TDes& aName)

	{

	__ASSERT_ALWAYS(aRequest->Operation()->Function()==EFsFileLock || aRequest->Operation()->Function()==EFsFileUnLock,Fault(EBaseRequestMessage));

	aLen = aRequest->Message().Int0();

	aPos = aRequest->Message().Int1();

	CFileShare* share = (CFileShare*)aRequest->ScratchValue();

	if(share == NULL)

		return(KErrBadHandle);

	NameFromShare(share, aName);

	return(KErrNone);

	}

/**

Utility function for obtaining info on file seek requests.  

@param	aRequest	File seek request

@param	aPos		The position within the file 

@param	aName		File name

@return Seek mode in format of TSeek 

*/

LOCAL_C TInt FileSeekVars(CFsRequest* aRequest, TInt& aPos, TDes& aName, const TAny*& aPtr)

	{

	__ASSERT_ALWAYS(aRequest->Operation()->Function()==EFsFileSeek,Fault(EBaseRequestMessage));

	aPos = aRequest->Message().Int0();

	CFileShare* share = (CFileShare*)aRequest->ScratchValue();

	if(share == NULL)

		return(KErrBadHandle);

	NameFromShare(share, aName);

	aPtr = aRequest->Message().Ptr1();

	return(KErrNone);

	}

/**

Utility function for obtaining info on file flush requests.  

@param	aRequest	File flush request

@param	aName		File name

*/

LOCAL_C TInt FileFlushVars(CFsRequest* aRequest, TDes& aName)

	{

	__ASSERT_ALWAYS(aRequest->Operation()->Function()==EFsFileFlush,Fault(EBaseRequestMessage));

	CFileShare* share = (CFileShare*)aRequest->ScratchValue();

	if(share == NULL)

		return(KErrBadHandle);

	NameFromShare(share, aName);

	return(KErrNone);

	}

/**

Utility function for obtaining info on file size/SetSize requests.  

@param	aRequest	File Size/SetSize request

@param	aSize		In case of Size() it is client's buffer, otherwise it is the desired size for SetSize

@param	aName		File name

*/

LOCAL_C TInt FileSizeVars(CFsRequest* aRequest,TInt& aSize, TDes& aName)

	{

	__ASSERT_ALWAYS(aRequest->Operation()->Function()==EFsFileSize || aRequest->Operation()->Function()==EFsFileSetSize,Fault(EBaseRequestMessage));

	aSize = aRequest->Message().Int0();

	CFileShare* share = (CFileShare*)aRequest->ScratchValue();

	if(share == NULL)

		return(KErrBadHandle);

	NameFromShare(share, aName);

	return(KErrNone);

	}

/**

Utility function for obtaining info on file Att requests.  

@param	aRequest	File Att request

@param	aAtt		Attribute of the file in question. 

@param	aName		File name

*/

LOCAL_C TInt FileAttVars(CFsRequest* aRequest,TInt& aAtt, TDes& aName)

	{

	__ASSERT_ALWAYS(aRequest->Operation()->Function()==EFsFileAtt,Fault(EBaseRequestMessage));

	CFileShare* share = (CFileShare*)aRequest->ScratchValue();

	if(share == NULL)

		return(KErrBadHandle);

	aAtt = (TInt)share->File().Att();

	NameFromShare(share, aName);

	return(KErrNone);

	}

/**

Utility function for obtaining info on file SetAtt requests.  

@param	aRequest		File SetAtt request

@param	aAtt			Current Attribute of the file 

@param	aName			File name

@param	aSetAttMask		The attribute mask to be set

@param  aClearAttMask	The attribute mask to be cleared

*/

LOCAL_C TInt FileSetAttVars(CFsRequest* aRequest,TInt& aAtt, TDes& aName, TUint& aSetAttMask,TUint& aClearAttMask)

	{

	__ASSERT_ALWAYS(aRequest->Operation()->Function()==EFsFileSetAtt,Fault(EBaseRequestMessage));

	CFileShare* share=(CFileShare*)aRequest->ScratchValue();

	if(share == NULL)

		return(KErrBadHandle);

	aAtt = (TInt)share->File().Att();

	NameFromShare(share, aName);

	aSetAttMask   = aRequest->Message().Int0(); 

	aClearAttMask = aRequest->Message().Int1();

	return(KErrNone);

	}

/**

Utility function for obtaining info on file modification requests.  

@param	aRequest		File Modified/SetModified request

@param	aAtt			Current Attribute of the file 

@param	aSize			Current size of the file

@param	aName			File name

@param  Moidfied		Last modified time of the file

@return if request is Modified, returns clients buffer

		if request is SetModified returns the desired last modification time

*/

LOCAL_C TInt FileModificationVars(CFsRequest* aRequest,TInt& aAtt, TInt& aSize, TDes& aName, TTime& aModified, TTime& aOldTime)

	{

	__ASSERT_ALWAYS(aRequest->Operation()->Function()==EFsFileModified || aRequest->Operation()->Function()==EFsFileSetModified,Fault(EBaseRequestMessage));

	CFileShare* share = (CFileShare*)aRequest->ScratchValue();

	if(share == NULL)

		return(KErrBadHandle);

	NameFromShare(share, aName);

	CFileCB& file = share->File();

	aAtt  = file.Att();

	aSize = file.Size();

	aOldTime = file.Modified();

	TPtr8 timePkg((TUint8*)&aModified, sizeof(TTime));

	TRAPD(err, aRequest->ReadL(KMsgPtr0, timePkg));

	return(err);

	}

/**

Utility function for obtaining info on file Set requests.  

@param	aRequest			File Set request

@param	aName				File name

@param	aCurrentAtt			Current Attribute of the file 

@param	aNewSetAtt			The new attribute to be set

@param	aNewClearAtt		The attribute to be cleared

@param  aCurrentModified	Last modified time of the file

@param  aNewModified		New last modified time of the file

*/

LOCAL_C TInt FileSetVars(CFsRequest* aRequest, TDes& aName, TInt& aCurrentAtt,TInt& aNewSetAtt, TInt& aNewClearAtt, TTime& aCurrentModified, TTime& aNewModified)

	{

	__ASSERT_ALWAYS(aRequest->Operation()->Function()==EFsFileSet,Fault(EBaseRequestMessage));

	CFileShare* share = (CFileShare*)aRequest->ScratchValue();

	if(share == NULL)

		return(KErrBadHandle);

	NameFromShare(share, aName);

	CFileCB& file = share->File();

	aCurrentAtt= file.Att();

	aCurrentModified = file.Modified();

	aNewSetAtt   = aRequest->Message().Int1();

	aNewClearAtt = aRequest->Message().Int2();

	TPtr8 timePkg((TUint8*)&aNewModified, sizeof(TTime));

	TRAPD(err, aRequest->ReadL(KMsgPtr0, timePkg));

	return(err);

	}

/**

Utility function for obtaining info on file ChangeMode requests.  

@param	aRequest			File Set request

@param	aName				File name

@param	aCurrentMode		Current mode of the file 

@param	aNewMode			The new mode of file (switch between EFileShareExclusive and EFileShareReadersOnly

@param  aModified			Last modified time of the file

*/

LOCAL_C TInt FileChangeModeVars(CFsRequest* aRequest, TDes& aName, TInt& aCurrentMode,TInt& aNewMode, TTime& aModified)

	{

	__ASSERT_ALWAYS(aRequest->Operation()->Function()==EFsFileChangeMode,Fault(EBaseRequestMessage));

	CFileShare* share = (CFileShare*)aRequest->ScratchValue();

	if(share == NULL)

		return(KErrBadHandle);

	NameFromShare(share, aName);

	aCurrentMode = share->iMode & KFileShareMask;

	aModified = share->File().Modified();

	aNewMode = aRequest->Message().Int0();

	return(KErrNone);

	}

/**

Utility function for obtaining info on file Rename requests.  

@param	aRequest			File Rename request

@param	aCurrentName		File's current name

@param	aCurrentDrive		File's current drive

@param	aNewName			the new name

@return KErrNone on successful read of info from CFsRequest or a system wide error 

*/

LOCAL_C TInt FileRenameVars(CFsRequest* aRequest, TDes& aCurrentName, TDriveUnit& aCurrentDrive, TDes& aNewName)

	{

	__ASSERT_ALWAYS(aRequest->Operation()->Function()==EFsFileRename,Fault(EBaseRequestMessage));

	CFileShare* share = (CFileShare*)aRequest->ScratchValue();

	if(share == NULL)

		return(KErrBadHandle);

	NameFromShare(share, aCurrentName);

	aCurrentDrive = share->File().Mount().Drive().DriveNumber();

	aNewName =	aRequest->Dest().FullName();

	return(KErrNone);

	}

/**

Utility function for obtaining info on file Drive/Name requests.  

@param	aRequest			File Rename request

@param	aFileName			File's current name

@param	aCurrentDrive		File's current drive

@param	aDriveInfo			File's drive information

*/

LOCAL_C TInt FileDriveNameVars(CFsRequest* aRequest, TDes& aFileName, TDriveUnit& aCurrentDrive,TDriveInfo& aDriveInfo)

	{

	__ASSERT_ALWAYS(aRequest->Operation()->Function()==EFsFileDrive || aRequest->Operation()->Function()==EFsFileName,Fault(EBaseRequestMessage));

	CFileShare* share = (CFileShare*)aRequest->ScratchValue();

	if(share == NULL)

		return(KErrBadHandle);

	NameFromShare(share, aFileName);

	aCurrentDrive = share->File().Mount().Drive().DriveNumber();

	share->File().Mount().Drive().DriveInfo(aDriveInfo);

	return(KErrNone);

	}

/**

Utility function for obtaining info on file delete requests.  

@param	aRequest			Dir read request

@param	aFileName			The name of the file

*/

LOCAL_C TInt FileDelVars(CFsRequest* aRequest, TDes& aFileName)

	{

	__ASSERT_ALWAYS(aRequest->Operation()->Function()==EFsDelete,Fault(EBaseRequestMessage));

	aFileName = aRequest->Src().FullName();

	return(KErrNone);

	}

/**

Utility function for obtaining info on file rename/replace requests.  

@param	aRequest			File rename/replace request

@param	aOldFileName		The old name of the file

@param	aNewFileName		The new name of the file

*/

LOCAL_C TInt FileRenameReplaceVars(CFsRequest* aRequest, TDes& aOldFileName,TDes& aNewFileName)

	{

	__ASSERT_ALWAYS(aRequest->Operation()->Function()==EFsRename || aRequest->Operation()->Function()==EFsReplace,Fault(EBaseRequestMessage));

	aOldFileName = aRequest->Src().FullName();

	aNewFileName = aRequest->Dest().FullName();

	return(KErrNone);

	}

/**

Utility function for obtaining info on file close requests.  

@param	aRequest			File close request

@param	aPath				The path of the file

@return	KErrNone

*/

LOCAL_C TInt FileCloseVars(CFsRequest* aRequest, TDes& aFileName)

	{

	__ASSERT_ALWAYS(aRequest->Operation()->Function()==EFsFileSubClose,Fault(EBaseRequestMessage));

	const TDes* fileName=(TDes*) I64HIGH(aRequest->ScratchValue64());

	if(fileName == NULL)

		return(KErrBadName);

	aFileName = _L("?:");

	aFileName[0] = TText('A' + aRequest->DriveNumber());

	aFileName.Append(*fileName);

	return(KErrNone);

	}

/**

Dir Operations

*/

/**

Utility function for obtaining info on dir Open requests.  

@param	aRequest			Dir Open request

@param	aDirName			Name of Dir

@param	aAtt				Attribute

@param	aUidType			Uid Type

*/

LOCAL_C TInt DirOpenVars(CFsRequest* aRequest, TDes& aDirName, TInt& aAtt,TInt& aUidType)

	{

	__ASSERT_ALWAYS(aRequest->Operation()->Function()==EFsDirOpen,Fault(EBaseRequestMessage));

	aDirName = aRequest->Src().FullName();

	aAtt = aRequest->Message().Int1();

	aUidType = aRequest->Message().Int2();

	return(KErrNone);

	}

/**

Utility function for obtaining info on dir Make requests. 

@param	aRequest			MkDir/MkDirAll request

@param	aMkDirAll			if MkDirAll it will be 1