// 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_cli.cpp

// 

//

#include "cl_std.h"

#include <f32fsys.h>

#ifdef OST_TRACE_COMPILER_IN_USE

#include "cl_cliTraces.h"

#endif

EFSRV_EXPORT_C TBool RFs::IsValidDrive(TInt aDrive)

/**

Tests whether the specified drive number is valid.

A valid drive number is any number between 0 and (KMaxDrives-1) inclusive,

or the specific value KDefaultDrive (implying the session default drive).

@param aDrive The drive number.

@return True if the drive is valid; false if not.				

@see TDriveNumber 				

*/

	{

	return((aDrive>=0 && aDrive<KMaxDrives) || aDrive==KDefaultDrive);

	}

EFSRV_EXPORT_C TInt RFs::CharToDrive(TChar aChar,TInt& aDrive)

/**

Maps a drive character to a drive number.

The drive character must be in the range A to Z or a to z. For example, drive A (or a)

corresponds to zero, drive B (or b) corresponds to 1 etc. For the drive number

enumeration, see TDriveNumber.

@param aChar  The drive character.

@param aDrive On return, contains the drive number.

@return KErrNone, if successful;

        KErrArgument, if the drive character is not in the range A to Z or a to z.

@see TDriveNumber        

*/

	{

	aChar.UpperCase();

	if (aChar>='A' && aChar<='Z')

		{

		aDrive=(TInt)aChar-'A';

		return(KErrNone);

		}

	return(KErrArgument);

	}

EFSRV_EXPORT_C TInt RFs::DriveToChar(TInt aDrive,TChar& aChar)

/**

Maps a drive number to the corresponding character.

The drive number must be in the range 0 to (KMaxDrives-1). For example, drive

number zero (EDriveA) corresponds to drive A, one (EDriveB)

corresponds to drive B. For the drive number enumeration, see TDriveNumber.

The drive number can also be KDefaultDrive, implying the default drive. In this

case the current drive is taken and converted.

@param aDrive The drive number.

@param aChar  On return, contains the drive character.

@return KErrNone, if successful;

        KErrArgument, if the drive number is invalid;

        otherwise one of the other system-wide error codes.

*/

	{

	if (aDrive==KDefaultDrive)

		{

		OstTrace1(TRACE_BORDER, EFSRV_EFSDRIVETOCHAR, "aDrive %d", aDrive);

		RFs fs;

		TFileName path;

		TInt r=fs.Connect();

		if (r!=KErrNone)

			return(r);

		r=fs.SessionPath(path);

		fs.Close();

		if (r!=KErrNone)

			return(r);

		aChar=path[0];

		OstTraceExt2(TRACE_BORDER, EFSRV_EFSDRIVETOCHARRETURN, "r %d aChar %x", (TUint) KErrNone, (TUint) aChar);

		return(KErrNone);

		}

	if (!IsValidDrive(aDrive))

		return(KErrArgument);

	aChar=aDrive+'A';

	return(KErrNone);

	}

EFSRV_EXPORT_C TBool RFs::IsRomAddress(TAny *aPtr)

/**

Tests whether the specified address is in ROM.

@param aPtr The address.

@return True, if the address is in ROM; false, if not.

*/

	{

	OstTrace1(TRACE_BORDER, EFSRV_EFSISROMADDRESS, "aPtr %x", aPtr);

	TBool res;

	TInt r=User::IsRomAddress(res,aPtr); // Only returns error on WINS

	if (r!=KErrNone)

		res=EFalse;

	OstTrace1(TRACE_BORDER, EFSRV_EFSISROMADDRESSRETURN, "r %d", res);

	return(res);

	}

/** 

Obtain the system drive number.

The System Drive is a defined drive on the device which is:

 - Read/Writeable

 - Internal: Always available and not removable from the device

 - Non-Volatile (e.g. Flash memory, battery-backed RAM)

 - Only Accessible via Rfs (e.g. not available via USB mass storage)

The System drive is utilised as:

 - Storage for Persistent settings from system and application software

 - Storage for Localisation resources

 - A Default Drive for user data

 - A Target Drive for Software installations

It the system drive is not set previously (see RFs::SetSystemDrive) EDriveC is returned by default.

@see RFs::GetSystemDriveChar

@see RFs::SetSystemDrive   

@see TDriveNumber

@return TDriveNumber contains the drive number of the system drive.

 */

EFSRV_EXPORT_C TDriveNumber RFs::GetSystemDrive()

    {

	OstTrace0(TRACE_BORDER, EFSRV_EFSGETSYSTEMDRIVE, "");

    TInt drive;

	TInt err = RProperty::Get(TSecureId(KFileServerUidValue), KSystemDriveKey, drive);

    if(err==KErrNone)

        {

        if((drive>=EDriveA) && (drive<=EDriveZ))

            {

			OstTrace1(TRACE_BORDER, EFSRV_EFSGETSYSTEMDRIVERETURN1, "r %d", drive);

            return static_cast<TDriveNumber>(drive);

            }

        }

	OstTrace1(TRACE_BORDER, EFSRV_EFSGETSYSTEMDRIVERETURN2, "r %d", EDriveC);

    return EDriveC;

	}

/**

This is a wrapper around GetSystemDrive() function. It returns the character corresponding to the system drive.

@parameter aDriveChar On return, contains the system drive character

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

@see RFs::GetSystemDrive

*/

EFSRV_EXPORT_C TChar RFs::GetSystemDriveChar()

	{

	OstTrace0(TRACE_BORDER, EFSRV_EFSGETSYSTEMDRIVECHAR, "");

	TInt r = 'A' + GetSystemDrive();

	OstTrace1(TRACE_BORDER, EFSRV_EFSGETSYSTEMDRIVECHARRETURN, "RFs::GetSystemDriveChar() r %x", (char) r);

	return r;

	}

/**

Set a specified drive as a "System Drive", see RFs::GetSystemDrive().

The "System Drive" can be set only once, any subsequent calls will result in the error 'KErrAlreadyExists'.

The media type for the system drive shall be one of the: EMediaHardDisk, EMediaFlash, EMediaNANDFlash, EMediaRam

Required drive attributes: KDriveAttLocal, KDriveAttInternal

Prohibited drive attributes: KDriveAttRom,KDriveAttRedirected,KDriveAttSubsted,KDriveAttRemovable

@param  aSystemDrive specifies the drive number to be set as System Drive

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

@capability TCB

*/

EFSRV_EXPORT_C TInt RFs::SetSystemDrive(TDriveNumber aSystemDrive)

	{

	OstTraceExt2(TRACE_BORDER, EFSRV_EFSSETSYSTEMDRIVE, "sess %x aSystemDrive %d", (TUint) Handle(), (TUint) aSystemDrive);

    TInt r = SendReceive(EFsSetSystemDrive, TIpcArgs(aSystemDrive));

	OstTrace1(TRACE_BORDER, EFSRV_EFSSETSYSTEMDRIVERETURN, "r %d", r);

	return r;

	}

EFSRV_EXPORT_C TInt RFs::Connect(TInt aMessageSlots)

/**

Connects a client to the file server.

To end the file server session, use Close().

@param aMessageSlots The number of message slots required. The default value of

				     KFileServerDefaultMessageSlots indicates that message

				     slots will be acquired dynamically from the system

				     wide pool. Override this value with a fixed number, if

				     a fixed number of slots are to be allocated to the session.

				     If overriding, note that the number of message slots

				     represents the number of operations, such as reads

				     and writes, that can be outstanding at once;

				     always remember to provide a spare slot for

				     the cancel operation.

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

        error codes.

*/

	{

	OstTrace1(TRACE_BORDER, EFSRV_EFSCONNECT, "aMessageSlots %d", aMessageSlots);

	_LIT(KFileServerName,"!FileServer");

	TInt r = CreateSession(KFileServerName,Version(),aMessageSlots);

	OstTraceExt2(TRACE_BORDER, EFSRV_EFSCONNECTRETURN, "r %d sess %x", (TUint) r, (TUint) Handle());

	return r;

	}

EFSRV_EXPORT_C TInt RFs::SetSessionToPrivate(TInt aDrive)

/**

Sets the session path to point to the private path on the specified drive.

The private directory does not need to exist at this point.

The private path for a process has the form: \\Private\\13579BDF\\

where 13579BDF is the identity of the process.

@param aDrive The drive for which information is requested.

              Specify a drive in the range EDriveA to EDriveZ for drives

			  A to Z respectively.

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

        error codes.

*/

	{	

	OstTraceExt2(TRACE_BORDER, EFSRV_EFSSETSESSIONTOPRIVATE, "sess %x  aDrive %d", (TUint) Handle(), (TUint) aDrive);

	TInt r = SendReceive(EFsSessionToPrivate,TIpcArgs(aDrive));

	OstTrace1(TRACE_BORDER, EFSRV_EFSSETSESSIONTOPRIVATERETURN, "r %d", r);

	return r;

	}

EFSRV_EXPORT_C TInt RFs::PrivatePath(TDes& aPath)

/**

Creates the text defining the private path for a process.

The private path for a process has the form: \\Private\\13579BDF\\

where 13579BDF is the identity of the process.

@param aPath On successful return, contains the private path for a process.

*/

	{

	OstTrace1(TRACE_BORDER, EFSRV_EFSPRIVATEPATH, "sess %x", Handle());

	TInt r = SendReceive(EFsPrivatePath,TIpcArgs(&aPath));

	OstTraceData(TRACE_BORDER, EFSRV_EFSPRIVATEPATH_EDIRNAME, "Dir %S", aPath.Ptr(), aPath.Length()<<1);

	OstTrace1(TRACE_BORDER, EFSRV_EFSPRIVATEPATHRETURN, "r %d", r);

	return r;

	}

EFSRV_EXPORT_C TInt RFs::CreatePrivatePath(TInt aDrive)

/**

Creates the private path for a process on the specified drive.

The private path for a process has the form: \\Private\\13579BDF\\

where 13579BDF is the identity of the process.

@param aDrive The drive for which the private path is to be created.

              Specify a drive in the range EDriveA to EDriveZ for drives

			  A to Z respectively.

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

        error codes.

*/

	{

	OstTraceExt2(TRACE_BORDER, EFSRV_EFSCREATEPRIVATEPATH, "sess %x aDrive %d", (TUint) Handle(), (TUint) aDrive);

	TInt r = SendReceive(EFsCreatePrivatePath,TIpcArgs(aDrive));

	OstTrace1(TRACE_BORDER, EFSRV_EFSCREATEPRIVATEPATHRETURN, "r %d", r);

	return r;

	}	

EFSRV_EXPORT_C TVersion RFs::Version() const

/**

Gets the client side version number.

@return The client side version number.

*/

	{

	OstTrace1(TRACE_BORDER, EFSRV_EFSVERSION, "sess %x", Handle());

	TVersion r = TVersion(KF32MajorVersionNumber,KF32MinorVersionNumber,KF32BuildVersionNumber);

	OstTraceExt3(TRACE_BORDER, EFSRV_EFSVERSIONRETURN, "iMajor %d iMinor %d iBuild %d", (TUint) r.iMajor, (TUint) r.iMinor, (TUint) r.iBuild);

	return r;

	}

/**

    Load file system plugin (*.fsy module) and add a file system that it implements to the file server. 

    After loading the file system plugin  RFs::MountFileSystem() can be used to mount the file system on a drive.

    @param aFileName    The name of the file system plugin (*.FSY) to install. If only file name without extension is specified, 

                        ".fsy" extension is assumed by default.

                        A full path to the FSY module can be specified, otherwise standard rules of loading DLLs apply. 

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

@capability DiskAdmin

@see RFs::MountFileSystem        

*/

EFSRV_EXPORT_C TInt RFs::AddFileSystem(const TDesC& aFileName) const

	{

	OstTrace1(TRACE_BORDER, EFSRV_EFSADDFILESYSTEM, "sess %x", Handle());

	OstTraceData(TRACE_BORDER, EFSRV_EFSADDFILESYSTEM_EFILENAME, "FileName %S", aFileName.Ptr(), aFileName.Length()<<1);

	RLoader loader;

	TInt r = loader.Connect();

	if (r==KErrNone)

		{

		r = loader.SendReceive(ELoadFileSystem, TIpcArgs(0, &aFileName, 0));

		loader.Close();

		}

	OstTrace1(TRACE_BORDER, EFSRV_EFSADDFILESYSTEMRETURN, "r %d", r);

	return r;

	}

/**

    Removes the specified file system from the file server and unloads its plugin dll (*.fsy)

    @param aFileSystemName  The name of the file system to be removed. File system name that is bound to some drive can be retrieved by 

                            RFs::FileSystemName(). Note that this is _not_ the name of the plugin (*.fsy).

    @return KErrNone        if successful

            KErrNotFound    if aFileSystemName is not found

            otherwise one of the other system-wide error codes.

    @capability DiskAdmin

*/

EFSRV_EXPORT_C TInt RFs::RemoveFileSystem(const TDesC& aFileSystemName) const

	{

	OstTrace1(TRACE_BORDER, EFSRV_EFSREMOVEFILESYSTEM, "sess %x", Handle());

	OstTraceData(TRACE_BORDER, EFSRV_EFSREMOVEFILESYSTEM_EFILESYSTEMNAME, "FileSystemName %S", aFileSystemName.Ptr(), aFileSystemName.Length()<<1);

	TInt r = SendReceive(EFsRemoveFileSystem,TIpcArgs(&aFileSystemName));

	OstTrace1(TRACE_BORDER, EFSRV_EFSREMOVEFILESYSTEMRETURN, "r %d", r);

	return r;

	}

/**

    Mounts a file system on a drive.

    The file system must first have been added to the file server using AddFileSystem().

    The drive is mounted as asynchronous, i.e operations on it don't block the file server and other drives;

    @param aFileSystemName  The name the file system, like "FAT". Note that this is _not_ the name of the plugin (*.fsy).

                            The file system name is case-insensitive, i.e. "FAT", "fat", "Fat" are equivalent.

                            The maximum lentgth of the file name is KMaxFSNameLength.

    @param aDrive           The drive number on which the file system is to be mounted; this can be one of the values defined by TDriveNumber.

    @return KErrNone        if successful 

            KErrLocked      if the media is locked

            KErrCorrupt     most likely means that the data structures on the media are not recognized by the given file system. This 

                            usually happens when the medium is damaged, unformatted, formatted with a different file system or vital file system structures are 

                            corrupted.

            otherwise one of the other system-wide error codes.

    @capability DiskAdmin

    @see RFs::AddFileSystem

    @see RFs::FileSystemName

*/

EFSRV_EXPORT_C TInt RFs::MountFileSystem(const TDesC& aFileSystemName,TInt aDrive) const

	{

	OstTraceExt2(TRACE_BORDER, EFSRV_EFSMOUNTFILESYSTEM1, "sess %x aDrive %d", (TUint) Handle(), (TUint) aDrive);

	OstTraceData(TRACE_BORDER, EFSRV_EFSMOUNTFILESYSTEM1_EFILESYSTEMNAME, "FileSystemName %S", aFileSystemName.Ptr(), aFileSystemName.Length()<<1);

	TInt r = SendReceive(EFsMountFileSystem,TIpcArgs(&aFileSystemName,aDrive,NULL,EFalse));

	OstTrace1(TRACE_BORDER, EFSRV_EFSMOUNTFILESYSTEM1RETURN, "r %d", r);

	return r;

	}

/**

    Mounts a file system on a drive.

The file system must first have been added to the file server using AddFileSystem().

Depending on the aIsSync parameter, the drive can be mounted as synchronous or asynchronous.

Asynchronous drive has its own processing thread, i.e operations on it don't block the file server and other drives;

Synchronous drives' requests are being processed by the main file server thread and there is a possibility to block it along with

all operations on other drives. Mounting a drive as synch. makes a sense if the operations on such drive are very fast e.g. this is an

internal RAM or ROFS drive.

    @param aFileSystemName  The name the file system, like "FAT". Note that this is _not_ the name of the plugin (*.fsy).

                            The file system name is case-insensitive, i.e. "FAT", "fat", "Fat" are equivalent.

                            The maximum lentgth of the file name is KMaxFSNameLength.

@param aDrive          The drive number on which the file system is to be mounted; this can be one of the values defined by TDriveNumber.

@param aIsSync         if ETrue  the drive will be mounted as synchronous one;

                       if EFalse the drive will be mounted as Asynchronous.

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

@capability DiskAdmin

@see RFs::AddFileSystem

@see RFs::FileSystemName

*/

EFSRV_EXPORT_C TInt RFs::MountFileSystem(const TDesC& aFileSystemName,TInt aDrive, TBool aIsSync) const

	{

	OstTraceExt3(TRACE_BORDER, EFSRV_EFSMOUNTFILESYSTEM2, "sess %x aDrive %d aIsSync %d", (TUint) Handle(), (TUint) aDrive, (TUint) aIsSync);

	OstTraceData(TRACE_BORDER, EFSRV_EFSMOUNTFILESYSTEM2_EFILESYSTEMNAME, "FileSystemName %S", aFileSystemName.Ptr(), aFileSystemName.Length()<<1);

	TInt r = SendReceive(EFsMountFileSystem,TIpcArgs(&aFileSystemName,aDrive,NULL,aIsSync));

	OstTrace1(TRACE_BORDER, EFSRV_EFSMOUNTFILESYSTEM2RETURN, "r %d", r);

	return r;

	}

/**

    Mounts a file system on a drive, along with the specified primary drive extension.

    The file system must first have been added to the file server using AddFileSystem().

    The extension must first have been added to the file server using AddExtension().

    The drive is mounted as asynchronous, i.e operations on it don't block the file server and other drives;

    @param aFileSystemName  The name the file system, like "FAT". Note that this is _not_ the name of the plugin (*.fsy).

                            The file system name is case-insensitive, i.e. "FAT", "fat", "Fat" are equivalent.

                            The maximum lentgth of the file name is KMaxFSNameLength.

    @param aExtensionName   The name of the primary drive extension. It has the same conventions as the aFileSystemName.

    @param aDrive           The drive on which the file system is to be mounted; this can be one of the values defined by TDriveNumber.

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

    @capability DiskAdmin

    @see RFs::AddFileSystem

    @see RFs::FileSystemName

*/

EFSRV_EXPORT_C TInt RFs::MountFileSystem(const TDesC& aFileSystemName,const TDesC& aExtensionName,TInt aDrive)

	{

	OstTraceExt2(TRACE_BORDER, EFSRV_EFSMOUNTFILESYSTEM3, "sess %x aDrive %d", (TUint) Handle(), (TUint) aDrive);

	OstTraceData(TRACE_BORDER, EFSRV_EFSMOUNTFILESYSTEM3_EEXTENSIONNAME, "ExtensionName %S", aExtensionName.Ptr(), aExtensionName.Length()<<1);

	OstTraceData(TRACE_BORDER, EFSRV_EFSMOUNTFILESYSTEM3_EFILESYSTEMNAME, "FileSystemName %S", aFileSystemName.Ptr(), aFileSystemName.Length()<<1);

	TInt r = SendReceive(EFsMountFileSystem,TIpcArgs(&aFileSystemName,aDrive,&aExtensionName,EFalse));

	OstTrace1(TRACE_BORDER, EFSRV_EFSMOUNTFILESYSTEM3RETURN, "r %d", r);

	return r;

	}

/**

    Mounts a file system on a drive, along with the specified primary drive extension.

    The file system must first have been added to the file server using AddFileSystem().

    The extension must first have been added to the file server using AddExtension().

    Depending on the aIsSync parameter, the drive can be mounted as synchronous or asynchronous.

    @param aFileSystemName  The name the file system, like "FAT". Note that this is _not_ the name of the plugin (*.fsy).

                            The file system name is case-insensitive, i.e. "FAT", "fat", "Fat" are equivalent.

                            The maximum lentgth of the file name is KMaxFSNameLength.

    @param aExtensionName   The name of the primary drive extension. It has the same conventions as the aFileSystemName.

    @param aDrive           The drive on which the file system is to be mounted; this can be one of the values defined by TDriveNumber.

    @param aIsSync         if ETrue  the drive will be mounted as synchronous one;