// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "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:

//

#include <bautils.h>

#include <mtp/cmtptypestring.h>

#include <mtp/mtpdatatypeconstants.h>

#include <mtp/mtpprotocolconstants.h>

#include "cmtpdataprovidercontroller.h"

#include "cmtpstoragemgr.h"

// Class constants.

__FLOG_STMT(_LIT8(KComponent,"StorageMgr");)

// StorageID bit manipulation patterns.

static const TUint32    KLogicalIdMask(0x0000FFFF);

static const TUint32    KPhysicalIdMask(0xFFFF0000);

static const TUint      KLogicalNumberMask(0x000000FF);

static const TUint      KLogicalOwnerShift(8);

static const TUint      KPhysicalNumberShift(16);

static const TUint      KPhysicalOwnerShift(24);

static const TUint8     KMaxOwnedStorages(0xFF);

/**

MTP data provider framework storage manager factory method.

@return A pointer to an MTP data provider framework storage manager. Ownership 

IS transfered.

@leave One of the system wide error codes, if a processing failure occurs.

*/

EXPORT_C CMTPStorageMgr* CMTPStorageMgr::NewL()

    {

    CMTPStorageMgr* self = new(ELeave) CMTPStorageMgr();

    CleanupStack::PushL(self);

    self->ConstructL();

    CleanupStack::Pop(self);

    return self;

    }

/**

Destructor.

*/

EXPORT_C CMTPStorageMgr::~CMTPStorageMgr()

    {

    __FLOG(_L8("~CMTPStorageMgr - Entry"));

    iPhysicalStorageNumbers.Reset();

    iStorages.ResetAndDestroy();

    iSingletons.Close();

    __FLOG(_L8("~CMTPStorageMgr - Exit"));

    __FLOG_CLOSE;

    }

/**

Extracts the storage number of the logical storage ID encoded in the specified

StorageID.

@param aStorageId The storage ID.

@return The storage number.

*/

EXPORT_C TUint CMTPStorageMgr::LogicalStorageNumber(TUint32 aStorageId) 

    {

    return (aStorageId & KLogicalNumberMask);

    }

/**

Extracts the ID of the data provider responsible for the logical storage ID 

encoded in the specified StorageID.

@param aStorageId The storage ID.

@return The data provider owner ID.

*/    

EXPORT_C TUint CMTPStorageMgr::LogicalStorageOwner(TUint32 aStorageId) 

    {

    return ((aStorageId & KLogicalIdMask) >> KLogicalOwnerShift);

    }

/**

Extracts the storage number of the physical storage ID encoded in the specified

StorageID.

@param aStorageId The storage ID.

@return The storage number.

*/

EXPORT_C TUint CMTPStorageMgr::PhysicalStorageNumber(TUint32 aStorageId) 

    {

    return ((aStorageId & KPhysicalIdMask) >> KPhysicalNumberShift);

    }

/**

Extracts the ID of the data provider responsible for the physical storage ID 

encoded in the specified StorageID.

@param aStorageId The storage ID.

@return The data provider owner ID.

*/

EXPORT_C TUint CMTPStorageMgr::PhysicalStorageOwner(TUint32 aStorageId) 

    {

    return ((aStorageId & KPhysicalIdMask) >> KPhysicalOwnerShift);

    }

/**

Sets the default MTP StorageID. This should be set once at start up and not 

subsequently changed.

@param aStorageId The system default MTP StorageID.

@panic USER 0, in debug builds only, if the default StorageID is set more than

once.

*/    

EXPORT_C void CMTPStorageMgr::SetDefaultStorageId(TUint32 aStorageId)

    {

    __FLOG(_L8("SetDefaultStorageId - Entry"));

    iDefaultStorageId = aStorageId;

    __FLOG_VA((_L8("Default StorageId = 0x%08X"), aStorageId));

    __FLOG(_L8("SetDefaultStorageId - Exit"));

    }

/**

Creates a mapping between the specified Symbian OS drive number and MTP 

StorageID.

@param aDriveNumber The Symbian OS drive number.

@param aStorageId The MTP StorageID.

@leave One of the sysem wide error codes, if a processing failure occurs.

*/

EXPORT_C void CMTPStorageMgr::SetDriveMappingL(TDriveNumber aDriveNumber, TUint32 aStorageId)

    {

    __FLOG(_L8("DefineDriveNumberMapping - Entry"));

    iMapDriveToStorage[aDriveNumber] = aStorageId;

    __FLOG_VA((_L8("Drive number %d = StorageID 0x%08X"), aDriveNumber, aStorageId));

    __FLOG(_L8("DefineDriveNumberMapping - Exit"));

    }

/**

Sets the framework storages owner identifier. This should be set once at start 

up and not subsequently changed.

@param aDataProviderId The framework storages owner identifier.

@panic USER 0, in debug builds only, if the framework storages owner identifier

is set more than once.

*/    

EXPORT_C void CMTPStorageMgr::SetFrameworkId(TUint aDataProviderId)

    {

    __FLOG(_L8("SetFrameworkStoragesOwner - Entry"));

    __ASSERT_DEBUG((iFrameworkId == KErrNotFound), User::Invariant());

    iFrameworkId = aDataProviderId;

    __FLOG_VA((_L8("System storages owner DP Id = %d"), aDataProviderId));

    __FLOG(_L8("SetFrameworkStoragesOwner - Exit"));

    }    

EXPORT_C TUint32 CMTPStorageMgr::AllocateLogicalStorageIdL(TUint aDataProviderId, TDriveNumber aDriveNumber, const CMTPStorageMetaData& aStorage)

    {

    __FLOG(_L8("AllocateLogicalStorageIdL - Entry"));

    TUint id(AllocateLogicalStorageIdL(aDataProviderId, PhysicalStorageId(aDriveNumber), aStorage));

    __FLOG(_L8("AllocateLogicalStorageIdL - Exit"));

    return id;

    }

EXPORT_C TUint32 CMTPStorageMgr::AllocateLogicalStorageIdL(TUint aDataProviderId, TUint32 aPhysicalStorageId, const CMTPStorageMetaData& aStorage)

    {

    __FLOG(_L8("AllocateLogicalStorageIdL - Entry"));

    //if support uninstall DP, comment the below assert.

    //__ASSERT_DEBUG((aDataProviderId < iSingletons.DpController().Count()), User::Invariant());

    // Resolve the physical storage.

    CMTPStorageMetaData& physical(StorageMetaDataL(aPhysicalStorageId));

    // Validate the SUID and storage type.

    if (iStorages.Find(aStorage.DesC(CMTPStorageMetaData::EStorageSuid), StorageKeyMatchSuid) != KErrNotFound)

        {

        // SUID is not unique.

        User::Leave(KErrAlreadyExists);

        }

    else if (aStorage.Uint(CMTPStorageMetaData::EStorageSystemType) != physical.Uint(CMTPStorageMetaData::EStorageSystemType))

        {

        // Physical/logical storage type mis-match.

        User::Leave(KErrArgument);

        }

    else if (aStorage.Uint(CMTPStorageMetaData::EStorageSystemType) == CMTPStorageMetaData::ESystemTypeDefaultFileSystem)

        {   

        // Validate that the SUID path exists.

        if (!BaflUtils::PathExists(iSingletons.Fs(), aStorage.DesC(CMTPStorageMetaData::EStorageSuid)))

            {

            User::Leave(KErrPathNotFound);

            }

        // Validate that the SUID path corresponds to the physical storage drive.

        TInt storageDrive(DriveNumber(aPhysicalStorageId));

        TParse p;

        User::LeaveIfError(p.Set(aStorage.DesC(CMTPStorageMetaData::EStorageSuid), NULL, NULL));

        TInt suidDrive(0);

        User::LeaveIfError(iSingletons.Fs().CharToDrive(TChar(p.Drive()[0]), suidDrive));

        if (suidDrive != storageDrive)

            {

            // SUID path/physical storage drive mis-match.

            User::Leave(KErrArgument);

            }

        }

    // Allocate a logical StorageId.

    TInt32 id(AllocateLogicalStorageId(aDataProviderId, aPhysicalStorageId));

    User::LeaveIfError(id);

    // Create the logical storage meta-data.

    CMTPStorageMetaData* logical(CMTPStorageMetaData::NewLC(aStorage));

    logical->SetUint(CMTPStorageMetaData::EStorageId, id);

    // Store the logical storage meta-data.

    iStorages.InsertInOrderL(logical, StorageOrder);

    CleanupStack::Pop(logical);

    // Associate the logical and physical storages.

    RArray<TUint> logicals;

    CleanupClosePushL(logicals);

    physical.GetUintArrayL(CMTPStorageMetaData::EStorageLogicalIds, logicals);

    logicals.InsertInOrderL(id);

    physical.SetUintArrayL(CMTPStorageMetaData::EStorageLogicalIds, logicals);

    CleanupStack::PopAndDestroy(&logicals);

#ifdef __FLOG_ACTIVE

    HBufC8* buf(HBufC8::NewLC(aStorage.DesC(CMTPStorageMetaData::EStorageSuid).Length()));

    buf->Des().Copy(aStorage.DesC(CMTPStorageMetaData::EStorageSuid));

    __FLOG_VA((_L8("Allocated logical StorageID 0x%08X for storage SUID %S"), id, buf));

    CleanupStack::PopAndDestroy(buf);

#endif // __FLOG_ACTIVE    

    __FLOG(_L8("AllocateLogicalStorageIdL - Exit"));

    return id;

    }

EXPORT_C TUint32 CMTPStorageMgr::AllocatePhysicalStorageIdL(TUint aDataProviderId, const CMTPStorageMetaData& aStorage)

    {

    __FLOG(_L8("AllocatePhysicalStorageIdL - Entry"));

    // Validate the SUID.

    if (iStorages.Find(aStorage.DesC(CMTPStorageMetaData::EStorageSuid), StorageKeyMatchSuid) != KErrNotFound)

        {

        // SUID is not unique.

        User::Leave(KErrAlreadyExists);

        }

    // Allocate a physical StorageId.

    TInt32 id(AllocatePhysicalStorageId(aDataProviderId));

    User::LeaveIfError(id);

    // Create the physical storage meta-data.

    CMTPStorageMetaData* physical(CMTPStorageMetaData::NewLC(aStorage));

    const RArray<TUint> noStorages;

    physical->SetUint(CMTPStorageMetaData::EStorageId, id);

    physical->SetUintArrayL(CMTPStorageMetaData::EStorageLogicalIds, noStorages);

    // Store the physical storage meta-data.

    iStorages.InsertInOrderL(physical, StorageOrder);

    CleanupStack::Pop(physical);

    __FLOG_VA((_L8("Allocated physical StorageID 0x%08X"), id));

    __FLOG(_L8("AllocatePhysicalStorageIdL - Exit"));

    return id;

    }

EXPORT_C TInt CMTPStorageMgr::DeallocateLogicalStorageId(TUint aDataProviderId, TUint32 aLogicalStorageId)

    {

    __FLOG(_L8("DeallocateLogicalStorageId - Entry"));

    TInt ret(KErrArgument);

    // Validate the StorageID.

    if (LogicalStorageId(aLogicalStorageId))

        {

        ret = iStorages.FindInOrder(aLogicalStorageId, StorageOrder);

        if (ret != KErrNotFound)

            {

            // Validate the storage owner.

            if (LogicalStorageOwner(iStorages[ret]->Uint(CMTPStorageMetaData::EStorageId)) != aDataProviderId)

                {

                ret = KErrAccessDenied;

                }

            else

                {

                TRAPD(err, RemoveLogicalStorageL(ret));

                ret = err;

                }

            }

        }

    __FLOG(_L8("DeallocateLogicalStorageId - Exit"));

    return ret;

    }

EXPORT_C void CMTPStorageMgr::DeallocateLogicalStorageIds(TUint aDataProviderId, TUint32 aPhysicalStorageId)

    {

    __FLOG(_L8("DeallocateLogicalStorageIds - Entry"));

    TInt ret(iStorages.FindInOrder(aPhysicalStorageId, StorageOrder));

    if (ret != KErrNotFound)

        {

        const RArray<TUint>& logicals(iStorages[ret]->UintArray(CMTPStorageMetaData::EStorageLogicalIds));

        TUint count(logicals.Count());

        while (count)

            {

            const TUint KIdx(count - 1);

            if (LogicalStorageOwner(logicals[KIdx]) == aDataProviderId)

                {

                DeallocateLogicalStorageId(aDataProviderId, logicals[KIdx]);

                }

            count--;

            }

        }

    __FLOG(_L8("DeallocateLogicalStorageIds - Exit"));

    }

EXPORT_C TInt CMTPStorageMgr::DeallocatePhysicalStorageId(TUint aDataProviderId, TUint32 aPhysicalStorageId)

    {

    __FLOG(_L8("DeallocatePhysicalStorageId - Entry"));

    TInt ret(KErrArgument);

    // Validate the StorageID.

    if (!LogicalStorageId(aPhysicalStorageId))

        {

        ret = iStorages.FindInOrder(aPhysicalStorageId, StorageOrder);

        if (ret != KErrNotFound)

            {

            // Validate the storage owner.

            if (PhysicalStorageOwner(iStorages[ret]->Uint(CMTPStorageMetaData::EStorageId)) != aDataProviderId)

                {

                ret = KErrAccessDenied;

                }

            else

                {

                // Deallocate all associated logical storages.

                const RArray<TUint>& logicals(iStorages[ret]->UintArray(CMTPStorageMetaData::EStorageLogicalIds));

                TUint count(logicals.Count());

                while (count)

                    {

                    const TUint KIdx(--count);

                    DeallocateLogicalStorageId(aDataProviderId, logicals[KIdx]);

                    }

                // Delete the storage.

                delete iStorages[ret];

                iStorages.Remove(ret);

                }

            }

        }

    __FLOG(_L8("DeallocatePhysicalStorageId - Exit"));

    return ret;

    }

EXPORT_C TUint32 CMTPStorageMgr::DefaultStorageId() const

    {

    __FLOG(_L8("DefaultStorageId - Entry"));

    __FLOG(_L8("DefaultStorageId - Exit"));

    }

EXPORT_C TInt CMTPStorageMgr::DriveNumber(TUint32 aStorageId) const

    {

    __FLOG(_L8("DriveNumber - Entry"));

    TInt drive(KErrNotFound);

    if (PhysicalStorageOwner(aStorageId) == iFrameworkId)

        {

        const TUint32 KPhysicalId(PhysicalStorageId(aStorageId));

        const TUint KCount(iMapDriveToStorage.Count());

        for (TUint i(0); ((i < KCount) && (drive == KErrNotFound)); i++)

            {

            if (PhysicalStorageId(iMapDriveToStorage[i]) == KPhysicalId)

                {

                drive = i;

                }

            }

        }

    __FLOG(_L8("DriveNumber - Exit"));

    return drive;

    }

EXPORT_C TInt32 CMTPStorageMgr::FrameworkStorageId(TDriveNumber aDriveNumber) const

    {

    __FLOG(_L8("FrameworkStorageId - Entry"));

    TInt32 ret(KErrNotFound);

    TInt32 id(iMapDriveToStorage[aDriveNumber]);

    if ((id != KErrNotFound) && (LogicalStorageId(id)))

        {

        ret = id;

        }

    __FLOG(_L8("FrameworkStorageId - Exit"));

    return ret;

    }

EXPORT_C void CMTPStorageMgr::GetAvailableDrivesL(RArray<TDriveNumber>& aDrives) const

    {

    __FLOG(_L8("GetAvailableDrivesL - Entry"));

    aDrives.Reset();

    for (TUint i(0); (i < iMapDriveToStorage.Count()); i++)

        {

        if (iMapDriveToStorage[i] != KErrNotFound)

            {

            aDrives.AppendL(static_cast<TDriveNumber>(i));

            }

        }

    __FLOG(_L8("GetAvailableDrivesL - Exit"));

    }

EXPORT_C void CMTPStorageMgr::GetLogicalStoragesL(const TMTPStorageMgrQueryParams& aParams, RPointerArray<const CMTPStorageMetaData>& aStorages) const

    {

    __FLOG(_L8("GetLogicalStoragesL - Entry"));

    aStorages.Reset();

    const TBool KAllStorages(aParams.StorageSuid() == KNullDesC);

    const TBool KAllStorageSystemTypes(aParams.StorageSystemType() == CMTPStorageMetaData::ESystemTypeUndefined);

    const TUint KCount(iStorages.Count());

    for (TUint i(0); (i < KCount); i++)

        {

        const CMTPStorageMetaData& storage(*iStorages[i]);

        if (((KAllStorages) || (storage.DesC(CMTPStorageMetaData::EStorageSuid) == aParams.StorageSuid())) &&

            ((KAllStorageSystemTypes) || (storage.Uint(CMTPStorageMetaData::EStorageSystemType) == aParams.StorageSystemType())) &&

            (LogicalStorageId(storage.Uint(CMTPStorageMetaData::EStorageId))))

            {

            aStorages.AppendL(iStorages[i]);

            }

        }

    __FLOG(_L8("GetLogicalStoragesL - Exit"));

    }

EXPORT_C void CMTPStorageMgr::GetPhysicalStoragesL(const TMTPStorageMgrQueryParams& aParams, RPointerArray<const CMTPStorageMetaData>& aStorages) const

    {

    __FLOG(_L8("GetPhysicalStoragesL - Entry"));

    aStorages.Reset();

    const TBool KAllStorages(aParams.StorageSuid() == KNullDesC);

    const TBool KAllStorageSystemTypes(aParams.StorageSystemType() == CMTPStorageMetaData::ESystemTypeUndefined);

    const TUint KCount(iStorages.Count());

    for (TUint i(0); (i < KCount); i++)

        {

        const CMTPStorageMetaData& storage(*iStorages[i]);

        if (((KAllStorages) || (storage.DesC(CMTPStorageMetaData::EStorageSuid) == aParams.StorageSuid())) &&

            ((KAllStorageSystemTypes) || (storage.Uint(CMTPStorageMetaData::EStorageSystemType) == aParams.StorageSystemType())) &&

            (!LogicalStorageId(storage.Uint(CMTPStorageMetaData::EStorageId))))

            {

            aStorages.AppendL(iStorages[i]);

            }

        }

    __FLOG(_L8("GetPhysicalStoragesL - Exit"));

    }

EXPORT_C TUint32 CMTPStorageMgr::LogicalStorageId(TUint32 aStorageId) const

    {

    __FLOG(_L8("LogicalStorageId - Entry"));

    __FLOG(_L8("LogicalStorageId - Exit"));

    return (aStorageId & KLogicalIdMask);

    }

EXPORT_C TInt32 CMTPStorageMgr::LogicalStorageId(const TDesC& aStorageSuid) const

    {

    __FLOG(_L8("LogicalStorageId - Entry"));

    TInt32 id(KErrNotFound);

    TInt idx(iStorages.Find(aStorageSuid, StorageKeyMatchSuid));

    if (idx != KErrNotFound)

        {

        id = iStorages[idx]->Uint(CMTPStorageMetaData::EStorageId);

        if (!LogicalStorageId(id))

            {

            id = KErrNotFound;

            }

        }

    __FLOG(_L8("LogicalStorageId - Exit"));

    return id;

    }

EXPORT_C TInt32 CMTPStorageMgr::PhysicalStorageId(TDriveNumber aDriveNumber) const

    {

    __FLOG(_L8("PhysicalStorageId - Entry"));

    TInt32 storageId(iMapDriveToStorage[aDriveNumber]);

    if (storageId != KErrNotFound)

        {

        storageId = PhysicalStorageId(storageId);

        }

    __FLOG(_L8("PhysicalStorageId - Exit"));

    return storageId;

    }

EXPORT_C TUint32 CMTPStorageMgr::PhysicalStorageId(TUint32 aStorageId) const

    {