// Copyright (c) 1995-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\sfsrv\cl_file.cpp

// 

//

#include "cl_std.h"

static _LIT_SECURITY_POLICY_S1(KFileServerPolicy,KFileServerUidValue,ECapabilityTCB);

EFSRV_EXPORT_C TInt RFile::Adopt(RFs& aFs, TInt aHandle)

/**

Adopts an already open file.

@param aFs     The file server session.

@param aHandle The handle number of the already opened file

@return KErrNone if successful, 

		KErrBadHandle if the sub-session handle is invalid, 

		otherwise one of the other system-wide error codes.

@deprecated

*/

	{

	// duplicate the sub-session handle; don't panic if it's invalid.

	RFile file;

	TInt r = file.CreateSubSession(aFs, EFsFileDuplicate, TIpcArgs(aHandle, EFalse));

	if (r == KErrArgument)

		{

		return KErrBadHandle;

		}

	else if (r != KErrNone)

		{

		return r;

		}

	// adopt the duplicated handle

	r = CreateAutoCloseSubSession(aFs, EFsFileAdopt, TIpcArgs(file.SubSessionHandle(), KFileAdopt32));

	return r;

	}

EFSRV_EXPORT_C TInt RFile::AdoptFromServer(TInt aFsHandle, TInt aFileHandle)

/**

Allows a client to adopt an already open file from a server.

Assumes that the server's RFs and RFile handles have been sent to the 

client using TransferToClient().

This RFile will own it's RFs session so that when the sub-session (RFile) 

is closed so will the RFs session.

@param aFsHandle The file server session (RFs) handle

@param aFileHandle The file (RFile) handle of the already opened file

@return KErrNone if successful, otherwise one of the other system-wide

        error codes.

*/

	{

	RFs fs;

	TInt r = fs.SetReturnedHandle(aFsHandle, KFileServerPolicy);

	if (r != KErrNone)

		{

		return r;

		}

	r = CreateAutoCloseSubSession(fs, EFsFileAdopt, TIpcArgs(aFileHandle, KFileAdopt32));

	return r;

	}

EFSRV_EXPORT_C TInt RFile::AdoptFromClient(const RMessage2& aMsg, TInt aFsHandleIndex, TInt aFileHandleIndex)

/**

Allows a server to adopt an already open file from a client.

The client's RFs and RFile handles are contained in message slots within aMsg.

Assumes that the client's RFs and RFile handles have been sent to the server

using TransferToServer().

This RFile will own it's RFs session so that when the sub-session (RFile) 

is closed so will the RFs session.

@param	aMsg		The message received from the client

@param	aFsHandleIndex	The index that identifies the message slot 

					of a file server session (RFs) handle

@param aFileHandleIndex The index that identifies the message slot 

					of the sub-session (RFile) handle of the already opened file

@return KErrNone if successful, otherwise one of the other system-wide

        error codes.

*/

	{

	TInt fileHandle = NULL;

	TInt r = KErrNone;

	if (aFileHandleIndex == 0)

		fileHandle = aMsg.Int0();

	else if (aFileHandleIndex == 1)

   		fileHandle = aMsg.Int1();

	else if (aFileHandleIndex == 2)

		fileHandle = aMsg.Int2();

	else if (aFileHandleIndex == 3)

		fileHandle = aMsg.Int3();

	else

		r = KErrArgument;

	TInt handle = NULL;

	if (aFsHandleIndex == 0)

		handle = aMsg.Int0();

	else if (aFsHandleIndex == 1)

   		handle = aMsg.Int1();

	else if (aFsHandleIndex == 2)

		handle = aMsg.Int2();

	else if (aFsHandleIndex == 3)

		handle = aMsg.Int3();

#endif

	if (r != KErrNone)

		{

		return r;

		}

	// Duplicates the file server (RFs) session handle identified by an 

	// existing handle contained in the message slot at index aFsHandleIndex

	RFs fs;

	r = fs.Open(aMsg, aFsHandleIndex, KFileServerPolicy);

	if (r != KErrNone)

		{

		return r;

		}

	r = CreateAutoCloseSubSession(fs, EFsFileAdopt, TIpcArgs(fileHandle, KFileAdopt32));

	return r;

	}

EFSRV_EXPORT_C TInt RFile::AdoptFromCreator(TInt aFsHandleIndex, TInt aFileHandleIndex)

/**

Allows a server to adopt an already open file from a client process.

The client's file-server (RFs) and file (RFile) handles are contained in 

this process's environment data slots.

Assumes that the client's RFs and RFile handles have been sent to the server process

using TransferToProcess().

This RFile will own it's RFs session so that when the sub-session (RFile) 

is closed so will the RFs session.

@param	aFsHandleIndex	An index that identifies the slot in the process

					environment data that contains the file server session (RFs) handle

@param	aFileHandleIndex	An index that identifies the slot in the process

					environment data that contains the sub-session (RFile) handle 

					of the already opened file

@return KErrNone if successful, otherwise one of the other system-wide

        error codes.

*/

	{

	TInt fileHandle = NULL;

	TInt r = User::GetTIntParameter(aFileHandleIndex,  fileHandle);

	if (r != KErrNone)

		{

		return r;

		}

	// Duplicates the file server (RFs) session handle identified by an 

	// existing handle contained in the environment slot at index aFsHandleIndex

	RFs fs;

	r = fs.Open(aFsHandleIndex, KFileServerPolicy);

	if (r != KErrNone)

		{

		return r;

		}

	r = CreateAutoCloseSubSession(fs, EFsFileAdopt, TIpcArgs(fileHandle, KFileAdopt32));

	return r;

	}

/**

Make a duplicate of the passed file handle in the same thread.

By default, any thread in the process can use the duplicated handle to access the 

file. However, specifying EOwnerThread as the second parameter to this function, 

means that only the creating thread can use the handle.

@param	aFile	The file handle to duplicate

@param	aType	An enumeration whose enumerators define the ownership of this 

				handle. If not explicitly specified, EOwnerProcess is taken

				as default.

@return	one of the other system-wide error codes.

*/

EFSRV_EXPORT_C TInt RFile::Duplicate(const RFile& aFile, TOwnerType aType)

	{

	RFs fs;

	fs.SetHandle(aFile.Session().Handle());

	// Need to make a duplicate of the session handle in the current thread, 

	// otherwise closing one session will close both sub-sessions.

	TInt r = fs.Duplicate(RThread(), aType);

	if (r != KErrNone)

		{

		return r;

		}

	// duplicate the sub-session handle

	TInt dupSubSessionHandle;

	r = aFile.DuplicateHandle(dupSubSessionHandle);

	if (r != KErrNone)

		{

		return r;

		}

	// adopt the duplicated sub-session handle

	r = CreateAutoCloseSubSession(fs, EFsFileAdopt, TIpcArgs(dupSubSessionHandle, KFileDuplicate));

	return r;

	}

// Makes a duplicate of this file (RFile) handle in the current thread and 

// returns it in aSubSessionHandle. 

// The duplicate file handle will effectively be in limbo (although still 

// owned by the session) until :

// (1) the session handle is duplicated into another process - 

//     this happens in one of : TransferToClient(), TransferToProcess() or 

//     AdoptFromClient() and

// (2) the sub-session handle is transferred to the other process - using AdoptXXX()

// 

TInt RFile::DuplicateHandle(TInt& aSubSessionHandle) const

	{

	RFs fs;

	fs.SetHandle(Session().Handle());

	RFile file;

	// duplicate the sub-session handle; panic if it's invalid.

	TInt r = file.CreateSubSession(fs, EFsFileDuplicate, TIpcArgs(SubSessionHandle(), ETrue));

	// return the duplicated handle

	// Note that this handle needs to be adopted before it can be used

	aSubSessionHandle = file.SubSessionHandle();

	return r;

	}

/**

Transfers an already open file to a server.

Before this function can be called, the file server session which owns this file handle

must first be marked as shareable by calling RFs::ShareProtected().

This function packages handle details for this file into 2 arguments of a TIpcArgs object.

When these arguments are sent in an IPC message, the server which receives them may 

call AdoptFromClient() to open a new RFile object which refers to the same file as this.

@param	aIpcArgs	The IPC message arguments.

@param	aFsHandleIndex	An index that identifies an argument in aIpcArgs where the

					file server session handle will be stored.

					This argument must not be used for anything else otherwise the 

					results will be unpredictable.

@param	aFileHandleIndex	An index that identifies an argument in aIpcArgs where the

					file handle will be stored.

					This argument must not be used for anything else otherwise the 

					results will be unpredictable.

@return KErrNone if successful, otherwise one of the other system-wide

		error codes.

*/

EFSRV_EXPORT_C TInt RFile::TransferToServer(TIpcArgs& aIpcArgs, TInt aFsHandleIndex, TInt aFileHandleIndex) const

	{

	if ((aFsHandleIndex < 0) || (aFsHandleIndex > (KMaxMessageArguments-2)))

		{

		return KErrArgument;

		}

	TInt dupSubSessionHandle;

	TInt r = DuplicateHandle(dupSubSessionHandle);

	if (r == KErrNone)

		{

		aIpcArgs.Set(aFsHandleIndex, Session());

		aIpcArgs.Set(aFileHandleIndex, dupSubSessionHandle);

		}

	return r;

	}

/**

Transfers an already open file from a server to a client.

Before this function can be called, the file server session which owns this file handle

must first be marked as shareable by calling RFs::ShareProtected().

The file (RFile) handle is written to the client's address space to the package 

buffer in the message address slot in aMsg identified by aFileHandleIndex.

If no error occurs, then the message is completed with the file-server (RFs) 

session handle.

When the message completes, the client may call AdoptFromServer() to open 

a new RFile object which refers to the same file as this.

Note that if an error occurs then the message is not completed.

@param	aMsg		A message received from the client

@param	aFileHandleIndex	Identifies the message slot that contains a package 

					buffer pointing to an address in the client's address space 

					to receive the file (RFile) handle

@return KErrNone if successful, otherwise one of the other system-wide

        error codes.

*/

EFSRV_EXPORT_C TInt RFile::TransferToClient(const RMessage2& aMsg, TInt aFileHandleIndex) const

	{

	if (TUint(aFileHandleIndex) >= TUint(KMaxMessageArguments))

		{

		return KErrArgument;

		}

	TInt dupSubSessionHandle;

	TInt r = DuplicateHandle(dupSubSessionHandle);

	if (r == KErrNone)

		r = aMsg.Write(aFileHandleIndex, TPckgC<TInt>(dupSubSessionHandle));

	if (r != KErrNone)

		{

		return r;

		}

	aMsg.Complete(Session());

	return r;

	}

/**

Transfers an already open file to another process.

Before this function can be called, the file server session which owns this file handle

must first be marked as shareable by calling RFs::ShareProtected().

This function packages handle details for this file into 2 arguments in another

process's  environment data slots.

When the other process runs, it may call AdoptFromCreator() to open a new RFile 

object which refers to the same file as this.

@param	aProcess	A handle to another process.

@param	aFsHandleIndex	An index that identifies a slot in the process's

					environment data which on exit will contain the file server 

					session (RFs) handle 

					This slot must not be used for anything else otherwise the 

					results will be unpredictable.

@param	aFileHandleIndex	An index that identifies a slot in the process's

					environment data which on exit will contain the file 

					(RFile) handle.

					This slot must not be used for anything else otherwise the 

					results will be unpredictable.

@return KErrNone if successful, otherwise one of the other system-wide

        error codes.

*/

// NB slot 0 is reserved for the command line

EFSRV_EXPORT_C TInt RFile::TransferToProcess(RProcess& aProcess, TInt aFsHandleIndex, TInt aFileHandleIndex) const

	{

	TInt dupSubSessionHandle;

	TInt r = DuplicateHandle(dupSubSessionHandle);

	if (r == KErrNone)

		r = aProcess.SetParameter(aFsHandleIndex, RHandleBase(Session()));

	if (r == KErrNone)

		r = aProcess.SetParameter(aFileHandleIndex, dupSubSessionHandle);

	return r;

	}

EFSRV_EXPORT_C TInt RFile::Name(TDes& aName) const

/**

Gets the final part of a filename

This is used to retrieve the name and extension of a file that has been 

passed from one process to another using the RFile::AdoptXXX() methods.

@param	aName	On return, contains the name of the file, including the name and 

				extension but excluding the drive letter and path.

@return KErrNone if successful, otherwise one of the other

        system-wide error codes.

*/

	{

	TInt r = SendReceive(EFsFileName, TIpcArgs(&aName));

	return r;

	}

EFSRV_EXPORT_C TInt RFile::FullName(TDes& aName) const

/**

Gets the full filename

This is used to retrieve the full filename, including drive and path,

of a file that has been passed from one process to another using the 

RFile::AdoptXXX() methods.

@param	aName	On return, contains the full name of the file, including drive and path.

@return KErrNone if successful, otherwise one of the other

        system-wide error codes.

*/

	{

	TInt r = SendReceive(EFsFileFullName, TIpcArgs(&aName));

	return r;

	}

EFSRV_EXPORT_C TInt RFile::Open(RFs& aFs,const TDesC& aName,TUint aMode)

/**

Opens an existing file for reading or writing.

If the file does not already exist, an error is returned.

Notes:

1. To close the file, use Close()

2. Attempting to open a file with the read-only attribute using the EFileWrite

   access mode results in an error.

3. Attempting to open a file which is greater than or equal to 2GByte (2,147,483,648 bytes)

   will fail with KErrTooBig

4. After a file has been opened, the current write position is set to the start

   of the file.

   If necessary, use RFile::Seek() to move to a different position within

   the file.

@param aFs   The file server session.

@param aName The name of the file. Any path components (i.e. drive letter

             or directory), which are not specified, are taken from

             the session path.The file name shall not contain wild cards

             ('?' or '*' characters) and illegal characters like 

             '<', '>', ':', '"', '/', '|' and '\000'. Backslash '\\' character 

             is allowed only as a path delimiter. The filename containing only 

             white space characters (See TChar::IsSpace()) is also illegal.

@param aMode The mode in which the file is opened. See TFileMode.

@return KErrNone if successful, otherwise one of the other system-wide

        error codes.

@see TFileMode

@capability Dependent If the path for aName is /Sys and aMode is neither

					  EFileShareReadersOnly nor EFileRead then Tcb capability is required.

@capability Dependent If the path for aName is /Sys and aMode is either

					  EFileShareReadersOnly or EFileRead then Allfiles capability is required.

@capability Dependent If the path for aName begins with /Private and does not match this process'

					  SID then AllFiles capability is required.

@capability Dependent If the path for aName begins with /Resource and aMode is neither

 					  EFileShareReadersOrWriters|EFileRead nor EFileShareReadersOnly 

 					  nor EFileRead then Tcb capability is required.

*/

	{