/*

* Copyright (c) 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:  Implement the operation: MoveObject

*

*/

#include <bautils.h>

#include <mtp/mmtpdataproviderframework.h>

#include <mtp/mmtpobjectmgr.h>

#include <mtp/mmtpstoragemgr.h>

#include <mtp/mmtpreferencemgr.h>

#include <mtp/cmtpobjectmetadata.h>

#include <mtp/cmtptypearray.h>

#include <mtp/cmtptypestring.h>

#include <mtp/cmtptypeobjectproplist.h>

#include "cmoveobject.h"

#include "mmmtpdplogger.h"

#include "tmmmtpdppanic.h"

#include "mmmtpdputility.h"

#include "cmmmtpdpmetadataaccesswrapper.h"

#include "mmmtpdpconfig.h"

/**

* Verification data for the MoveObject request

*/

const TMTPRequestElementInfo KMTPMoveObjectPolicy[] =

    {

        {

        TMTPTypeRequest::ERequestParameter1, EMTPElementTypeObjectHandle,

                EMTPElementAttrFileOrDir | EMTPElementAttrWrite, 0, 0, 0

        },

        {

        TMTPTypeRequest::ERequestParameter2, EMTPElementTypeStorageId,

                EMTPElementAttrWrite, 0, 0, 0

        },

        {

        TMTPTypeRequest::ERequestParameter3, EMTPElementTypeObjectHandle,

                EMTPElementAttrDir | EMTPElementAttrWrite, 1, 0, 0

        }

    };

// -----------------------------------------------------------------------------

// CMoveObject::NewL

// Two-phase construction method

// -----------------------------------------------------------------------------

//

//EXPORT_C MMmRequestProcessor* CMoveObject::NewL( MMTPDataProviderFramework& aFramework,

//        MMTPConnection& aConnection,

//        CMmMtpDpMetadataAccessWrapper& aWrapper )

//    {

//    CMoveObject* self = new (ELeave) CMoveObject( aFramework, aConnection, aWrapper );

//    CleanupStack::PushL( self );

//    self->ConstructL();

//    CleanupStack::Pop( self );

//

//    return self;

//    }

// -----------------------------------------------------------------------------

// CMoveObject::~CMoveObject

// Destructor

// -----------------------------------------------------------------------------

//

EXPORT_C CMoveObject::~CMoveObject()

    {

    Cancel();

    delete iDest;

    delete iFileMan;

    delete iPathToMove;

    delete iNewRootFolder;

    iObjectHandles.Close();

    if ( iPropertyElement )

        delete iPropertyElement;

    delete iPropertyList;

    }

// -----------------------------------------------------------------------------

// CMoveObject::CMoveObject

// Standard c++ constructor

// -----------------------------------------------------------------------------

//

EXPORT_C CMoveObject::CMoveObject( MMTPDataProviderFramework& aFramework,

        MMTPConnection& aConnection,

        MMmMtpDpConfig& aDpConfig) :

    CRequestProcessor( aFramework, aConnection, sizeof( KMTPMoveObjectPolicy )

            /sizeof( TMTPRequestElementInfo ), KMTPMoveObjectPolicy),

    iDpConfig( aDpConfig ),

    iObjectHandles( KMmMtpRArrayGranularity ),

    iMoveObjectIndex( 0 )

    {

    PRINT( _L( "Operation: MoveObject(0x1019)" ) );

    }

// -----------------------------------------------------------------------------

// CMoveObject::ServiceL

// MoveObject request handler

// -----------------------------------------------------------------------------

//

EXPORT_C void CMoveObject::ServiceL()

    {

    PRINT( _L( "MM MTP => CMoveObject::ServiceL" ) );

    TMTPResponseCode ret = MoveObjectL();

    PRINT1( _L( "MM MTP <> CMoveObject::ServiceL ret = 0x%x" ), ret );

    if ( EMTPRespCodeOK != ret )

        {

        SendResponseL( ret );

        }

    PRINT( _L( "MM MTP <= CMoveObject::ServiceL" ) );

    }

// -----------------------------------------------------------------------------

// CMoveObject::ConstructL

// Second phase constructor

// -----------------------------------------------------------------------------

//

EXPORT_C void CMoveObject::ConstructL()

    {

    CActiveScheduler::Add( this );

    iPropertyList = CMTPTypeObjectPropList::NewL();

    SetPSStatus();

    }

// -----------------------------------------------------------------------------

// CMoveObject::RunL

//

// -----------------------------------------------------------------------------

//

EXPORT_C void CMoveObject::RunL()

    {

    PRINT( _L( "MM MTP => CMoveObject::RunL" ) );

    if ( MoveOwnedObjectsL() )

        {

        // Reset iMoveObjectIndex count since move completed

        iMoveObjectIndex = 0;

        TMTPResponseCode ret = EMTPRespCodeOK;

        // Delete the original folders in the device dp.

        if ( iObjectInfo->Uint( CMTPObjectMetaData::EDataProviderId )

                == iFramework.DataProviderId() )

            {

            ret = FinalPhaseMove();

            }

        PRINT1( _L("MM MTP <> CMoveObject::RunL ret = 0x%x"), ret );

        SendResponseL( ret );

        }

    PRINT( _L( "MM MTP <= CMoveObject::RunL" ) );

    }

// -----------------------------------------------------------------------------

// CMoveObject::RunError

//

// -----------------------------------------------------------------------------

//

EXPORT_C TInt CMoveObject::RunError( TInt aError )

    {

    if ( aError != KErrNone )

        PRINT1( _L( "MM MTP <> CMoveObject::RunError aError = %d" ), aError );

    TRAP_IGNORE( SendResponseL( EMTPRespCodeGeneralError ) );

    return KErrNone;

    }

// -----------------------------------------------------------------------------

// CMoveObject::MoveFileL

// A helper function of MoveObjectL

// -----------------------------------------------------------------------------

//

void CMoveObject::MoveFileL( const TDesC& aNewFileName )

    {

    PRINT1( _L( "MM MTP => CMoveObject::MoveFileL aNewFileName = %S" ), &aNewFileName );

    const TDesC& suid( iObjectInfo->DesC( CMTPObjectMetaData::ESuid ) );

    TFileName oldFileName( suid ); // save the old file name, the suid will be modified

    PRINT1( _L( "MM MTP <> CMoveObject::MoveFileL oldFileName = %S" ), &suid );

    if ( iStorageId == iObjectInfo->Uint( CMTPObjectMetaData::EStorageId ) )

        iSameStorage = ETrue;

    else

        iSameStorage = EFalse;

    GetPreviousPropertiesL( *iObjectInfo );

    User::LeaveIfError( iFileMan->Move( suid, aNewFileName ) ); // iDest just Folder

    User::LeaveIfError( iFramework.Fs().SetModified( aNewFileName, iPreviousModifiedTime ) );

    iObjectInfo->SetDesCL( CMTPObjectMetaData::ESuid, aNewFileName );

    iObjectInfo->SetUint( CMTPObjectMetaData::EStorageId, iStorageId );

    iObjectInfo->SetUint( CMTPObjectMetaData::EParentHandle, iNewParentHandle );

    iFramework.ObjectMgr().ModifyObjectL( *iObjectInfo );

    SetPropertiesL( oldFileName, aNewFileName, *iObjectInfo );

    PRINT( _L( "MM MTP <= CMoveObject::MoveFileL" ) );

    }

// -----------------------------------------------------------------------------

// CMoveObject::MoveOwnedObjectsL

// Move the objects through iterations of RunL

// -----------------------------------------------------------------------------

//

TBool CMoveObject::MoveOwnedObjectsL()

    {

    PRINT( _L( "MM MTP => CMoveObject::MoveOwnedObjectsL" ) );

    TBool ret = EFalse;

    if ( iMoveObjectIndex < iNumberOfObjects )

        {

        MoveAndUpdateL( iObjectHandles[iMoveObjectIndex++] );

        TRequestStatus* status = &iStatus;

        User::RequestComplete( status, iStatus.Int() );

        SetActive();

        }

    else

        {

        ret = ETrue;

        }

    PRINT1( _L( "MM MTP <= CMoveObject::MoveOwnedObjectsL ret = %d" ), ret );

    return ret;

    }

// -----------------------------------------------------------------------------

// CMoveObject::MoveFolderL

// A helper function of MoveObjectL

// -----------------------------------------------------------------------------

//

void CMoveObject::MoveFolderL()

    {

    PRINT( _L( "MM MTP => CMoveObject::MoveFolderL" ) );

    RBuf oldFolderName;

    oldFolderName.CreateL( KMaxFileName );

    oldFolderName.CleanupClosePushL(); // + oldFileName

    oldFolderName = iObjectInfo->DesC( CMTPObjectMetaData::ESuid );

    PRINT1( _L( "MM MTP <> CMoveObject::MoveFolderL oldFolderName = %S" ), &oldFolderName );

    iPathToMove = oldFolderName.AllocL();

    CleanupStack::PopAndDestroy( &oldFolderName ); // - oldFolderName

    GenerateObjectHandleListL( iObjectInfo->Uint( CMTPObjectMetaData::EHandle ) );

    iNumberOfObjects = iObjectHandles.Count();

    PRINT1( _L( "MM MTP <> CMoveObject::MoveFolderL iNumberOfObjects = %d" ), iNumberOfObjects );

    TRequestStatus* status = &iStatus;

    User::RequestComplete( status, iStatus.Int() );

    SetActive();

    PRINT( _L( "MM MTP <= CMoveObject::MoveFolderL" ) );

    }

// -----------------------------------------------------------------------------

// CMoveObject::MoveObjectL

// move object operations

// -----------------------------------------------------------------------------

//

TMTPResponseCode CMoveObject::MoveObjectL()

    {

    PRINT( _L( "MM MTP => CMoveObject::MoveObjectL" ) );

    TMTPResponseCode responseCode = EMTPRespCodeOK;

    GetParametersL();

    RBuf newObjectName;

    newObjectName.CreateL( KMaxFileName );

    newObjectName.CleanupClosePushL(); // + newObjectName

    newObjectName = *iDest;

    const TDesC& suid( iObjectInfo->DesC( CMTPObjectMetaData::ESuid ) );

    TParsePtrC fileNameParser( suid );

    // Check if the object is a folder or a file.

    TBool isFolder = EFalse;

    User::LeaveIfError( BaflUtils::IsFolder( iFramework.Fs(), suid, isFolder ) );

    if ( !isFolder )

        {

        if ( ( newObjectName.Length() + fileNameParser.NameAndExt().Length() ) <= newObjectName.MaxLength() )

            {

            newObjectName.Append( fileNameParser.NameAndExt() );

            }

        responseCode = CanMoveObjectL( suid, newObjectName );

        }

    else // It is a folder.

        {

        TFileName rightMostFolderName;

        User::LeaveIfError( BaflUtils::MostSignificantPartOfFullName( suid,

                rightMostFolderName ) );

        if ( ( newObjectName.Length() + rightMostFolderName.Length() + 1 ) <= newObjectName.MaxLength() )

            {

            newObjectName.Append( rightMostFolderName );

            // Add backslash.

            _LIT( KBackSlash, "\\" );

            newObjectName.Append( KBackSlash );

            }

        }

    iNewRootFolder = newObjectName.AllocL();

    if ( responseCode == EMTPRespCodeOK )

        {

        delete iFileMan;

        iFileMan = NULL;

        iFileMan = CFileMan::NewL( iFramework.Fs() );

        if ( !isFolder )

            {

            MoveFileL( newObjectName );

            SendResponseL( responseCode );

            }

        else

            {

            MoveFolderL();

            }

        }

    CleanupStack::PopAndDestroy( &newObjectName ); // - newObjectName.

    PRINT1( _L( "MM MTP <= CMoveObject::MoveObjectL responseCode = 0x%x" ), responseCode );

    return responseCode;

    }

// -----------------------------------------------------------------------------

// CMoveObject::GetParametersL

// Retrieve the parameters of the request

// -----------------------------------------------------------------------------

//

void CMoveObject::GetParametersL()

    {

    PRINT( _L( "MM MTP => CMoveObject::GetParametersL" ) );

    __ASSERT_DEBUG( iRequestChecker, Panic( EMmMTPDpRequestCheckNull ) );

    TUint32 objectHandle = Request().Uint32( TMTPTypeRequest::ERequestParameter1 );

    iStorageId = Request().Uint32( TMTPTypeRequest::ERequestParameter2 );

    iNewParentHandle = Request().Uint32( TMTPTypeRequest::ERequestParameter3 );

    PRINT3( _L( "MM MTP <> objectHandle = 0x%x, iStoargeId = 0x%x, iNewParentHandle = 0x%x" ),

            objectHandle, iStorageId, iNewParentHandle );

    // not taking owernship

    iObjectInfo = iRequestChecker->GetObjectInfo( objectHandle );

    __ASSERT_DEBUG( iObjectInfo, Panic( EMmMTPDpObjectNull ) );

    if ( iNewParentHandle == 0 )

        {

        SetDefaultParentObjectL();

        }

    else

        {

        CMTPObjectMetaData* parentObjectInfo =

                iRequestChecker->GetObjectInfo( iNewParentHandle );

        __ASSERT_DEBUG( parentObjectInfo, Panic( EMmMTPDpObjectNull ) );

        delete iDest;

        iDest = NULL;

        iDest = parentObjectInfo->DesC( CMTPObjectMetaData::ESuid ).AllocL();

        PRINT1( _L( "MM MTP <> CMoveObject::GetParametersL iDest = %S" ), iDest );

        }

    PRINT( _L( "MM MTP <= CMoveObject::GetParametersL" ) );

    }

// -----------------------------------------------------------------------------

// CMoveObject::SetDefaultParentObjectL

// Get a default parent object, ff the request does not specify a parent object,

// -----------------------------------------------------------------------------

//

void CMoveObject::SetDefaultParentObjectL()

    {

    PRINT( _L( "MM MTP => CMoveObject::SetDefaultParentObjectL" ) );

    delete iDest;

    iDest = NULL;

    iDest = ( iFramework.StorageMgr().StorageL( iStorageId ).DesC(

                CMTPStorageMetaData::EStorageSuid ) ).AllocL();

    PRINT1( _L( "MM MTP <> CMoveObject::SetDefaultParentObjectL iDest = %S" ), iDest );

    iNewParentHandle = KMTPHandleNoParent;

    PRINT( _L( "MM MTP <= CMoveObject::SetDefaultParentObjectL" ) );

    }

// -----------------------------------------------------------------------------

// CMoveObject::CanMoveObjectL

// Check if we can move the file to the new location

// -----------------------------------------------------------------------------

//

TMTPResponseCode CMoveObject::CanMoveObjectL( const TDesC& aOldName,

        const TDesC& aNewName ) const

    {

    PRINT( _L( "MM MTP => CMoveObject::CanMoveObjectL" ) );

    TMTPResponseCode result = EMTPRespCodeOK;

    TEntry fileEntry;

    User::LeaveIfError( iFramework.Fs().Entry( aOldName, fileEntry ) );

    TDriveNumber drive( static_cast<TDriveNumber>( iFramework.StorageMgr().DriveNumber( iStorageId ) ) );

    User::LeaveIfError( drive );

    TVolumeInfo volumeInfo;

    User::LeaveIfError( iFramework.Fs().Volume( volumeInfo, drive ) );

    if ( volumeInfo.iFree < fileEntry.iSize )

        {

        result = EMTPRespCodeStoreFull;

        }

    else if ( BaflUtils::FileExists( iFramework.Fs(), aNewName ) )

        {

#ifdef MMMTPDP_REPLACE_EXIST_FILE

        // delete the old one and replace

        TInt delErr = iFramework.Fs().Delete( aNewName );

        PRINT1( _L( "MM MTP <> CMoveObject::CanMoveObjectL delErr = %d" ), delErr );

        // delete from the metadata DB

        TRAPD( err, iFramework.ObjectMgr().RemoveObjectL( aNewName ) );

        PRINT1( _L( "MM MTP <> CMoveObject::CanMoveObjectL err = %d" ), err );

        // delete from video/mpx DB

        CMTPObjectMetaData* objectInfo = CMTPObjectMetaData::NewLC(); // + objectInfo

        if ( iFramework.ObjectMgr().ObjectL( aNewName, *objectInfo ) )

            {

            TRAP( err, iDpConfig.GetWrapperL().DeleteObjectL( aNewName,

                objectInfo->Uint( CMTPObjectMetaData::EFormatCode ) ) );

            }

        CleanupStack::PopAndDestroy( objectInfo ); // - objectInfo

        if ( err )

            {

            // do nothing

            }

#else

        result = EMTPRespCodeInvalidParentObject;

#endif

        }

    PRINT1( _L( "MM MTP <= CMoveObject::CanMoveObjectL result = 0x%x" ), result );

    return result;

    }

// -----------------------------------------------------------------------------

// CMoveObject::GetPreviousPropertiesL

// Save the object properties before doing the move

// -----------------------------------------------------------------------------

//

void CMoveObject::GetPreviousPropertiesL( const CMTPObjectMetaData& aObject )

    {

    PRINT( _L( "MM MTP => CMoveObject::GetPreviousPropertiesL" ) );

    const TDesC& suid( aObject.DesC( CMTPObjectMetaData::ESuid ) );

    User::LeaveIfError( iFramework.Fs().Modified( suid, iPreviousModifiedTime ) );

    // same storage, not necessary to get the properties

    if ( iSameStorage )

        return;

    TUint formatCode = aObject.Uint( CMTPObjectMetaData::EFormatCode );

    const RArray<TUint>* properties = iDpConfig.GetSupportedPropertiesL( formatCode );

    TInt count = properties->Count();

    CMTPTypeString* textData = NULL;

    TInt err = KErrNone;

    TUint16 propCode;

    TUint32 handle = aObject.Uint( CMTPObjectMetaData::EHandle ) ;

    if ( iPropertyElement )

        {

        delete iPropertyElement;

        iPropertyElement = NULL;

        }

    for ( TInt i = 0; i < count; i++ )

        {

        propCode = (*properties)[i];

        switch( propCode )

            {

            case EMTPObjectPropCodeStorageID:

            case EMTPObjectPropCodeObjectFormat:

            case EMTPObjectPropCodeProtectionStatus:

            case EMTPObjectPropCodeObjectSize:

            case EMTPObjectPropCodeObjectFileName:

            case EMTPObjectPropCodeParentObject:

            case EMTPObjectPropCodePersistentUniqueObjectIdentifier:

            case EMTPObjectPropCodeNonConsumable:

            case EMTPObjectPropCodeDateCreated:

            case EMTPObjectPropCodeDateModified:

                break;

            case EMTPObjectPropCodeName:

            case EMTPObjectPropCodeDateAdded:

                if ( ( propCode == EMTPObjectPropCodeName )

                   || ( ( !MmMtpDpUtility::IsVideoL( aObject.DesC( CMTPObjectMetaData::ESuid ), iFramework ) )

                        && ( propCode == EMTPObjectPropCodeDateAdded ) ) )

                    {

                    textData = CMTPTypeString::NewLC(); // + textData

                    TRAP( err, iDpConfig.GetWrapperL().GetObjectMetadataValueL( propCode,

                        *textData,

                        aObject ) );

                    PRINT1( _L( "MM MTP <> CMoveObject::GetPreviousPropertiesL::ServiceSpecificObjectPropertyL err = %d" ), err );

                    if ( err == KErrNone )

                        {

                        iPropertyElement = &(iPropertyList->ReservePropElemL(handle, propCode));

                        iPropertyElement->SetStringL(CMTPTypeObjectPropListElement::EValue, textData->StringChars());

//                        iPropertyElement = CMTPTypeObjectPropListElement::NewL(

//                            handle, propCode, *textData );

                        }

                    else if ( err == KErrNotFound )

                        {

                        iPropertyElement = NULL;

                        }

                    else

                       {

                       User::Leave( err );

                       }

                    CleanupStack::PopAndDestroy( textData ); // - textData

                    }

                break;

            default:

                {

                ServiceGetSpecificObjectPropertyL( propCode, handle, aObject );

                }

                break;

            }

        if ( iPropertyElement )

            {

            iPropertyList->CommitPropElemL( *iPropertyElement );