sl@0: // Copyright (c) 2007-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: // Contains implementation of BSUL class to cache drive information
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @file
sl@0: */
sl@0: 
sl@0: #include <bsul/ccacheddriveinfo.h>
sl@0: 
sl@0: using namespace BSUL;
sl@0: 
sl@0: /**
sl@0:  Constructs CCachedDriveInfo object by retrieving the drive status using aFs
sl@0:  @param aFs Reference to connected filesystem
sl@0:  */
sl@0: EXPORT_C CCachedDriveInfo* CCachedDriveInfo::NewL(RFs& aFs)
sl@0: 	{
sl@0: 	CCachedDriveInfo *self = new(ELeave) CCachedDriveInfo();
sl@0: 	CleanupStack::PushL(self);
sl@0: 	self->ConstructL(aFs);
sl@0: 	CleanupStack::Pop(self);
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  Constructs CCachedDriveInfo object by retrieving the drive status using aFs
sl@0:  @param aFs Reference to connected filesystem
sl@0:  */
sl@0: EXPORT_C CCachedDriveInfo* CCachedDriveInfo::NewLC(RFs& aFs)
sl@0: 	{
sl@0: 	CCachedDriveInfo *self = new(ELeave) CCachedDriveInfo();
sl@0: 	CleanupStack::PushL(self);
sl@0: 	self->ConstructL(aFs);
sl@0: 	return self;
sl@0: 	}
sl@0: /**
sl@0:  @internalComponent
sl@0:  */
sl@0: CCachedDriveInfo::CCachedDriveInfo()
sl@0: 	{}
sl@0: 
sl@0: /**
sl@0:  @internalComponent
sl@0:  */
sl@0: void CCachedDriveInfo::ConstructL(RFs& aFs)
sl@0: 	{
sl@0: 	// Goes through each drive, and stores whether or not it is available, 
sl@0: 	// the drive's attributes, and the drive's media attributes
sl@0: 	for (TDriveUnit drive(EDriveZ); drive >= EDriveA; drive = TInt(drive) - 1)
sl@0: 		{
sl@0: 		ASSERT(aFs.IsValidDrive(drive));
sl@0: 		
sl@0: 		TDriveInfo driveInfo;
sl@0: 		User::LeaveIfError(aFs.Drive(driveInfo, drive));
sl@0: 		iDriveAndMediaAttributes[drive].iDriveAttributes = driveInfo.iDriveAtt;
sl@0: 		iDriveAndMediaAttributes[drive].iMediaAttributes = driveInfo.iMediaAtt;
sl@0: 		iDriveAndMediaAttributes[drive].iMediaType = driveInfo.iType;
sl@0: 		}
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0:  Frees all allocated resources
sl@0:  */
sl@0: EXPORT_C CCachedDriveInfo::~CCachedDriveInfo()
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  @internalComponent
sl@0:  Returns the TDriveUnit associated with the given path
sl@0:  @param aFullName File name that includes a drive
sl@0:  @return The drive unit associated with aFullName
sl@0:  @leave Leaves with a system-wide error code if the aFullName cannot be parsed,
sl@0:  		or with KErrBadName if the supplied path does not contain a drive letter
sl@0:  */
sl@0: TDriveUnit CCachedDriveInfo::PathToDriveUnitL(const TDesC& aFullName)
sl@0: 	{
sl@0: 	// check if the filename can be parsed
sl@0: 	TParse checkParse;
sl@0: 	TInt retcode = checkParse.Set(aFullName, NULL, NULL);
sl@0: 	User::LeaveIfError(retcode);
sl@0: 	
sl@0: 	TParsePtrC parse(aFullName);
sl@0: 	if (!parse.DrivePresent())
sl@0: 		{
sl@0: 		User::Leave(KErrBadName);
sl@0: 		}
sl@0: 	
sl@0: 	TDriveUnit driveId(aFullName);
sl@0: 	
sl@0: 	return driveId;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  Checks if the drive associated with aFullName is both read-only and internal by 
sl@0:  checking that the KMediaAttWriteProtected and KDriveAttInternal flags are both set.
sl@0: 
sl@0:  @param aFullName File name that includes a drive
sl@0:  @return Returns ETrue if the drive is read-only and internal, EFalse otherwise (including when the drive is not mounted)
sl@0:  @leave Leaves with a system-wide error code if the aFullName cannot be parsed,
sl@0:  		or with KErrBadName if the supplied path does not contain a drive letter
sl@0:  */
sl@0: EXPORT_C TBool CCachedDriveInfo::IsReadOnlyInternalL(const TDesC& aFullName) const
sl@0: 	{
sl@0: 	TDriveUnit driveId = PathToDriveUnitL(aFullName);
sl@0: 	
sl@0: 	return IsReadOnlyInternalL(driveId);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  Checks if the specified drive is both read-only and internal by checking that the 
sl@0:  KMediaAttWriteProtected and KDriveAttInternal flags are both set.
sl@0: 
sl@0:  @param aDrive The drive whose read-only status is being retrieved
sl@0:  @return Returns ETrue if the drive is read-only and internal, EFalse otherwise (including when the drive is not mounted)
sl@0:  @leave Leaves with KErrBadName if aDrive is not a valid drive between EDriveA and EDriveZ
sl@0:  */
sl@0: EXPORT_C TBool CCachedDriveInfo::IsReadOnlyInternalL(TDriveUnit aDrive) const
sl@0: 	{
sl@0: 	if (aDrive < EDriveA || aDrive > EDriveZ)
sl@0: 		{
sl@0: 		User::Leave(KErrBadName);
sl@0: 		}
sl@0: 
sl@0: 	if ( (iDriveAndMediaAttributes[aDrive].iDriveAttributes & KDriveAttInternal) &&
sl@0: 		 (iDriveAndMediaAttributes[aDrive].iMediaAttributes & KMediaAttWriteProtected) )
sl@0: 		{
sl@0: 		return ETrue;
sl@0: 		}
sl@0: 	
sl@0: 	return EFalse;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  This method allows the caller to test the attributes of a drive to see if 
sl@0:  they are set. For example, a drive can be check whether it is remote by 
sl@0:  checking the flag KDriveAttRemote is set.
sl@0:  Valid flags are those defined in e32const.h starting KDriveAtt*
sl@0: 
sl@0:  @see TDriveInfo
sl@0:  @param aDrive The drive whose attribute information is being tested
sl@0:  @param aFlags The attributes to be checked for the drive
sl@0:  @return ETrue if attributes in the drive are set, EFalse otherwise 
sl@0:  @leave KErrBadName if aDrive is not a valid drive between EDriveA and EDriveZ
sl@0:  */
sl@0: EXPORT_C TBool CCachedDriveInfo::IsFlagSetOnDriveL(TDriveUnit aDrive, TUint aFlags) const
sl@0: 	{
sl@0: 	if (aDrive < EDriveA || aDrive > EDriveZ)
sl@0: 		{
sl@0: 		User::Leave(KErrBadName);
sl@0: 		}
sl@0: 
sl@0: 	return ((iDriveAndMediaAttributes[aDrive].iDriveAttributes & aFlags) == aFlags) ? ETrue : EFalse;
sl@0: 	}
sl@0: 		
sl@0: /**
sl@0:  This method allows the caller to check the media type of a drive, to 
sl@0:  see if a drive is of a particular media type. It also optionally
sl@0:  returns the media type of the drive.
sl@0:   
sl@0:  @see TDriveInfo
sl@0:  @param aDrive The drive whose media type information is being checked.
sl@0:  @param aTestValue The media type to compare against the drive provided.
sl@0:  @param aActual return parameter - if the caller provides a pointer
sl@0:  for this parameter type, then it will be populated with the actual media type
sl@0:  of the drive. This is useful to avoid repeated queries if the media type
sl@0:  is needed.
sl@0:  @return ETrue if the drive media type matches the media type provided
sl@0:  @leave KErrBadName if aDrive is not a valid drive between EDriveA and EDriveZ
sl@0:  */
sl@0: EXPORT_C TBool CCachedDriveInfo::MediaTypeL(TDriveUnit aDrive, TMediaType aTestValue, TMediaType* aActual) const
sl@0: 	{
sl@0: 	if (aDrive < EDriveA || aDrive > EDriveZ)
sl@0: 		{
sl@0: 		User::Leave(KErrBadName);
sl@0: 		}
sl@0: 	
sl@0: 	if (aActual)
sl@0: 		{
sl@0: 		*aActual = iDriveAndMediaAttributes[aDrive].iMediaType;
sl@0: 		}
sl@0: 	
sl@0: 	return (iDriveAndMediaAttributes[aDrive].iMediaType == aTestValue) ? ETrue : EFalse;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  This method fetches the default removable memory card (MMC card). To determine
sl@0:  the MMC drive a default algorithm will be used.
sl@0: 
sl@0:  The algorithm to be used will be to search through the drive list provided
sl@0:  by RFs for the first drive that has the following properties 
sl@0:  1) Drive type is EMediaHardDisk
sl@0:  2) Drive attributes are KDriveAttRemovable and KDriveAttLocal
sl@0:   
sl@0:  @see TDriveInfo
sl@0:  @return TDriveUnit The drive found by the algorithm
sl@0:  @leave KErrNotFound if drive not found
sl@0:  */
sl@0: EXPORT_C TDriveUnit CCachedDriveInfo::GetDefaultRemovableMemoryCardDriveL() const
sl@0: 	{
sl@0: 	for (TInt driveNum=EDriveA; driveNum<=EDriveZ; driveNum++)
sl@0: 		{
sl@0: 	    // Confirmed on H4 board that the properties below were present for an MMC card. Also
sl@0: 		// E32 has a test PBASE-T_MMCDRV-0164 that also confirms this.
sl@0: 		if (IsFlagSetOnDriveL(driveNum, KDriveAttRemovable|KDriveAttLocal) &&
sl@0: 	        MediaTypeL(driveNum, EMediaHardDisk))
sl@0: 			{
sl@0: 			// Found MMC drive.
sl@0: 			return driveNum;
sl@0: 			}
sl@0: 	    }
sl@0: 
sl@0: 	// No valid MMC drive available.
sl@0: 	User::Leave(KErrNotFound);
sl@0: 	return -1; // to avoid warning
sl@0: 	}
sl@0: