harvesterplugins/file/src/cfolderrenamedharvester.cpp
author hgs
Fri, 15 Oct 2010 11:45:38 +0530
changeset 27 7a8855317cbd
parent 26 367228f82b66
permissions -rw-r--r--
201041

/*
* Copyright (c) 2010 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:  
*
*/


//  INCLUDES 
#include <e32base.h>
#include <pathinfo.h>
#include <bautils.h>

// For Logging
#include "harvesterserverlogger.h"

#include "cfileplugin.h"
#include "cfolderrenamedharvester.h"
#include "OstTraceDefinitions.h"
#ifdef OST_TRACE_COMPILER_IN_USE
#include "cfolderrenamedharvesterTraces.h"
#endif


// CONSTANTS
_LIT( KFileMask, "*.*" );
const TInt KItemsPerRun = 1;


namespace {

void AppendBackslash( TDes& aDirectory )
    {    
    const TInt lastChar = aDirectory.Length() - 1;
    const TChar KBackslashChar( '\\' );

    // If it is directory which not contain backslash. 
    if ( KBackslashChar != aDirectory[lastChar] )
       {
       aDirectory.Append( KBackslashChar );
       }
    }

void RemoveBackslash( TDes& aDirectory )
    {
    const TInt lastChar = aDirectory.Length() - 1;
    const TChar KBackslashChar( '\\' );
    
    //If directory contains slash at the end
    if ( KBackslashChar == aDirectory[lastChar] )
        {
        TPtrC temppath( aDirectory.Left( lastChar ) );
        aDirectory.Zero();
        aDirectory.Append(temppath);
        }
    
    }

} // namespace

// ============================ MEMBER FUNCTIONS ===============================


// ---------------------------------------------------------------------------
// CFolderRenamedItem::NewL
// ---------------------------------------------------------------------------
//
CFolderRenamedItem * CFolderRenamedItem::NewL(const TDesC &aOldName, const TDesC &aNewName)
	{
	CFolderRenamedItem *self = new (ELeave) CFolderRenamedItem();
	CleanupStack::PushL( self );
	self->ConstructL( aOldName, aNewName );
	CleanupStack::Pop( self );
	return self;
	}


// ---------------------------------------------------------------------------
// CFolderRenamedItem::~CFolderRenamedItem
// ---------------------------------------------------------------------------
//
CFolderRenamedItem::~CFolderRenamedItem()
    {
    delete iOldName;
    delete iNewName;
    }

// ---------------------------------------------------------------------------
// CFolderRenamedItem::CFolderRenamedItem
// ---------------------------------------------------------------------------
//
CFolderRenamedItem::CFolderRenamedItem()
	{
	}


// ---------------------------------------------------------------------------
// CFolderRenamedItem::ConstructL
// ---------------------------------------------------------------------------
//
void CFolderRenamedItem::ConstructL(const TDesC &aOldName, const TDesC &aNewName)
	{
	iOldName = aOldName.AllocL();
	iNewName = aNewName.AllocL();
	}


// ---------------------------------------------------------------------------
// CFolderRenamedItem::OldName
// ---------------------------------------------------------------------------
//
const TDesC& CFolderRenamedItem::OldName()
	{
	return *iOldName;
	}


// ---------------------------------------------------------------------------
// CFolderRenamedItem::NewName
// ---------------------------------------------------------------------------
//
const TDesC& CFolderRenamedItem::NewName()
	{
	return *iNewName;
	}

// ---------------------------------------------------------------------------
// CFolderRenamedHarvester::NewL
// ---------------------------------------------------------------------------
//
CFolderRenamedHarvester* CFolderRenamedHarvester::NewL(  CFilePlugin& aFilePlugin, RFs& aFs )
	{
	CFolderRenamedHarvester* self = new (ELeave) CFolderRenamedHarvester( aFilePlugin, aFs );
	CleanupStack::PushL(self);
	self->ConstructL();
	CleanupStack::Pop(self);
	return self;
	}

// ---------------------------------------------------------------------------
// CFolderRenamedHarvester::~CFolderRenamedHarvester
// ---------------------------------------------------------------------------
//
CFolderRenamedHarvester::~CFolderRenamedHarvester()
    {
    delete iDir;
    delete iDirscan;
    for ( int i =0; i < iRenamedFolders.Count(); i++ )
        {
        CFolderRenamedItem* item = iRenamedFolders[0];
        iRenamedFolders.Remove(0);
        delete item;
        item = NULL;
        }
    iRenamedFolders.ResetAndDestroy();
    iRenamedFolders.Close();
    Cancel();
    }

// ---------------------------------------------------------------------------
// CFolderRenamedHarvester::CFolderRenamedHarvester

// ---------------------------------------------------------------------------
//
CFolderRenamedHarvester::CFolderRenamedHarvester(  CFilePlugin& aFilePlugin, RFs& aFs  ) 
  : CActive( CActive::EPriorityIdle ),
    iFilePlugin( aFilePlugin ),
    iFs( aFs )
    {
    OstTraceFunctionEntry0( CFOLDERRENAMEDHARVESTER_CFOLDERRENAMEDHARVESTER_ENTRY );
    CPIXLOGSTRING("ENTER CFolderRenamedHarvester::CFolderRenamedHarvester");
    CActiveScheduler::Add( this );
    CPIXLOGSTRING("END CFolderRenamedHarvester::CFolderRenamedHarvester");
    OstTraceFunctionExit0( CFOLDERRENAMEDHARVESTER_CFOLDERRENAMEDHARVESTER_EXIT );
    }


// ---------------------------------------------------------------------------
// CFolderRenamedHarvester::ConstructL
// ---------------------------------------------------------------------------
//
void CFolderRenamedHarvester::ConstructL()
    {
    iDirscan = CDirScan::NewL( iFs );
    }

// ---------------------------------------------------------------------------
// CFolderRenamedHarvester::StartL
// ---------------------------------------------------------------------------
//
TBool CFolderRenamedHarvester::StartL( const TFileName& aOldDirectoryName, 
									   const TFileName& aNewDirectoryName )
    {
    OstTraceFunctionEntry0( CFOLDERRENAMEDHARVESTER_STARTL_ENTRY );
    CPIXLOGSTRING("ENTER CFolderRenamedHarvester::Start");

    // Append trailing backslash if required
    TFileName oldName ( aOldDirectoryName );
    AppendBackslash( oldName );
    TFileName newName ( aNewDirectoryName );
    AppendBackslash( newName );

    CFolderRenamedItem *renameItem = CFolderRenamedItem::NewL( oldName, newName );
    iRenamedFolders.AppendL( renameItem );

	SetNextRequest( EFolderRenamedIdleState );
    CPIXLOGSTRING("END CFolderRenamedHarvester::Start");
    OstTraceFunctionExit0( CFOLDERRENAMEDHARVESTER_STARTL_EXIT );
    return ETrue;
    }

// ---------------------------------------------------------------------------
// CFolderRenamedHarvester::GetNextFolderL
// ---------------------------------------------------------------------------
//		
void CFolderRenamedHarvester::GetNextFolderL()
    {
    OstTraceFunctionEntry0( CFOLDERRENAMEDHARVESTER_GETNEXTFOLDERL_ENTRY );
    CPIXLOGSTRING("ENTER CFolderRenamedHarvester::GetNextFolderL");   

    delete iDir;
    iDir = NULL;
    // Documentation: CDirScan::NextL() The caller of this function 
    // is responsible for deleting iDir after the function has returned.
    iDirscan->NextL(iDir); 

    if( iDir )
        {
        OstTrace0( TRACE_NORMAL, CFOLDERRENAMEDHARVESTER_GETNEXTFOLDERL, "CFolderRenamedHarvester::GetNextFolderL - IF EHarvesterGetFileId" );
        CPIXLOGSTRING("CFolderRenamedHarvester::GetNextFolderL - IF EHarvesterGetFileId"); 
        SetNextRequest( EFolderRenamedGetFileId );
        }
    else
        {
        OstTrace0( TRACE_NORMAL, DUP1_CFOLDERRENAMEDHARVESTER_GETNEXTFOLDERL, "CFolderRenamedHarvester::GetNextFolderL - IF EHarvesterIdle" );
        CPIXLOGSTRING("CFolderRenamedHarvester::GetNextFolderL - IF EHarvesterIdle");
        HandleFolderRenameL();
        // finished folder rename, delete the folder from the array.
        CFolderRenamedItem *item = iRenamedFolders[0];
        iRenamedFolders.Remove(0);
        delete item;

        SetNextRequest( EFolderRenamedIdleState );
        }
    CPIXLOGSTRING("END CFolderRenamedHarvester::GetNextFolderL");
    OstTraceFunctionExit0( CFOLDERRENAMEDHARVESTER_GETNEXTFOLDERL_EXIT );
    }

// ---------------------------------------------------------------------------
// CFolderRenamedHarvester::GetFileIdL
// 
// ---------------------------------------------------------------------------
//		    
void CFolderRenamedHarvester::GetFileIdL()
    {
    OstTraceFunctionEntry0( CFOLDERRENAMEDHARVESTER_GETFILEIDL_ENTRY );
    CPIXLOGSTRING("ENTER CFolderRenamedHarvester::GetFileId");

    if( iCurrentIndex == 0 )
        {
        TParse parse;
        parse.Set(KFileMask(), &iDirscan->FullPath(), NULL);

        // FindWildByPath assigns iDir = NULL, then allocates the memory for it.
        // Therefore must delete iDir first.
        delete iDir;
        iDir = NULL;

        TFindFile find( iFs );
        find.FindWildByPath(parse.FullName(), NULL, iDir);
        }

    if( iDir )
        {
        const TInt count(iDir->Count());
        while( ( iCurrentIndex < count ) && ( iStepNumber < KItemsPerRun ) )
            {
            TEntry entry = (*iDir)[iCurrentIndex];
            // Check if entry is a hidden or system file
            // if true -> continue until find something to index or have checked whole directory
            if( !entry.IsHidden() && !entry.IsSystem() )
                {
                TParse fileParser;
                fileParser.Set( iDirscan->FullPath(), &(*iDir)[iCurrentIndex].iName, NULL );

                TPtrC fileNamePtr = fileParser.FullName();
                TPtrC leaf( fileNamePtr.Right( fileNamePtr.Length() - iNewFolderName.Length() ) );
                TFileName oldFileName( iOldFolderName );
                oldFileName.Append( leaf );
                if(entry.IsDir())
                    {
                    if(iFilePlugin.GetHarvesterState())
                        {
                        iFilePlugin.CreateFolderFileIndexItemL( oldFileName, ECPixRemoveAction );
                        iFilePlugin.CreateFolderFileIndexItemL( fileParser.FullName(), ECPixAddAction );
                        }
                    else
                        {
                        iFilePlugin.AddToQueueL( oldFileName, ECPixRemoveAction, ETrue );
                        iFilePlugin.AddToQueueL( fileParser.FullName(), ECPixAddAction, ETrue );
                        }                    
                    }  
                else
                    {
                    if( iFilePlugin.GetHarvesterState() )
                        {
                        iFilePlugin.CreateContentIndexItemL( oldFileName, ECPixRemoveAction );
                        iFilePlugin.CreateFolderFileIndexItemL( oldFileName, ECPixRemoveAction, EFalse );
                
                        iFilePlugin.CreateContentIndexItemL( fileParser.FullName(), ECPixAddAction );
                        iFilePlugin.CreateFolderFileIndexItemL( fileParser.FullName(), ECPixAddAction, EFalse );
                        }
                    else
                        {
                        iFilePlugin.AddToQueueL( oldFileName, ECPixRemoveAction, EFalse );
                        iFilePlugin.AddToQueueL( fileParser.FullName(), ECPixAddAction, EFalse );
                        }
                    }                
                // TODO: If this is not TRAPPED, state machine breaks 
                iStepNumber++;
                }            
            iCurrentIndex++;
            }
            
        iStepNumber = 0;
        
        if( iCurrentIndex >= count )
            {
            iCurrentIndex = 0;
            SetNextRequest( EFolderRenamedStartHarvest );
            }
        else
            {
            SetNextRequest( EFolderRenamedGetFileId );
            }
        }
    else
        {
        SetNextRequest( EFolderRenamedStartHarvest );
        }
    CPIXLOGSTRING("END CFolderRenamedHarvester::GetFileId"); 
    OstTraceFunctionExit0( CFOLDERRENAMEDHARVESTER_GETFILEIDL_EXIT );
    }			

      
// -----------------------------------------------------------------------------
// CFolderRenamedHarvester::DoCancel
// -----------------------------------------------------------------------------
//   
void CFolderRenamedHarvester::DoCancel()
	{
	OstTrace0( TRACE_NORMAL, CFOLDERRENAMEDHARVESTER_DOCANCEL, "CFolderRenamedHarvester::DoCancel" );
	CPIXLOGSTRING("CFolderRenamedHarvester::DoCancel");
	}

// -----------------------------------------------------------------------------
// CFolderRenamedHarvester::RunL
// -----------------------------------------------------------------------------
//   
void CFolderRenamedHarvester::RunL()
    {
    OstTraceFunctionEntry0( CFOLDERRENAMEDHARVESTER_RUNL_ENTRY );
    CPIXLOGSTRING("ENTER CFolderRenamedHarvester::RunL");
     // Simple Round-Robin scheduling.
    Deque();
    CActiveScheduler::Add( this );

    switch ( iHarvestState )
        {
		case EFolderRenamedIdleState:
			{
			if ( iRenamedFolders.Count() == 0 )
				{
				OstTraceFunctionExit0( CFOLDERRENAMEDHARVESTER_RUNL_EXIT );
				return; // Nothing to do.
				}

			// Some rename folder action to perform
			iOldFolderName.Copy( iRenamedFolders[0]->OldName() );
			iNewFolderName.Copy( iRenamedFolders[0]->NewName() );

			iDirscan->SetScanDataL( iRenamedFolders[0]->NewName(),
						KEntryAttMatchExclusive|KEntryAttNormal,
						ESortNone, // No need to sort data
						CDirScan::EScanDownTree );
			// No break, fall through to EFolderRenamedStartHarvest case
			}
		case EFolderRenamedStartHarvest:
			{
			GetNextFolderL();
			break;
			}
		case EFolderRenamedGetFileId:
			{
			GetFileIdL();
			break;
			}
		default:
			break;
        }
    CPIXLOGSTRING("END CFolderRenamedHarvester::RunL");
    OstTraceFunctionExit0( DUP1_CFOLDERRENAMEDHARVESTER_RUNL_EXIT );
    }

// -----------------------------------------------------------------------------
// CFolderRenamedHarvester::RunError
// -----------------------------------------------------------------------------
//   
TInt CFolderRenamedHarvester::RunError(TInt aError)
	{
    OstTrace1( TRACE_NORMAL, CFOLDERRENAMEDHARVESTER_RUNERROR, "CFolderRenamedHarvester::RunError;aError=%d", aError );
    CPIXLOGSTRING2("CFolderRenamedHarvester::RunError - aError: %d", aError );
    for ( int i =0; i < iRenamedFolders.Count(); i++ )
        {
        CFolderRenamedItem* item = iRenamedFolders[0];
        iRenamedFolders.Remove(0);
        delete item;
        item = NULL;
        }
    iRenamedFolders.ResetAndDestroy();
	iHarvestState = EFolderRenamedIdleState;
	return KErrNone;
	}
	

// ---------------------------------------------------------------------------
// SetNextRequest
// ---------------------------------------------------------------------------
//
void CFolderRenamedHarvester::SetNextRequest( TFileHarvesterState aState )
    {
    OstTrace0( TRACE_NORMAL, CFOLDERRENAMEDHARVESTER_SETNEXTREQUEST, "CFolderRenamedHarvester::SetNextRequest" );
    CPIXLOGSTRING("CFolderRenamedHarvester::SetNextRequest");
    if ( !IsActive() )
        {
        iHarvestState = aState;
        SetActive();
        TRequestStatus* status = &iStatus;
        User::RequestComplete( status, KErrNone );
        }
    }

void CFolderRenamedHarvester::HandleFolderRenameL()
    {
    OstTraceFunctionEntry0( CFOLDERRENAMEDHARVESTER_HANDLEFOLDERRENAMEL_ENTRY );
    RemoveBackslash(iOldFolderName);
    RemoveBackslash(iNewFolderName);
    if(iFilePlugin.GetHarvesterState())
        {
        iFilePlugin.CreateFolderFileIndexItemL( iOldFolderName, ECPixRemoveAction );    
        iFilePlugin.CreateFolderFileIndexItemL( iNewFolderName, ECPixAddAction );
        }
    else
       iFilePlugin.AddToQueueL(iOldFolderName, ECPixRemoveAction, ETrue);
       iFilePlugin.AddToQueueL(iNewFolderName, ECPixAddAction, ETrue);
    OstTraceFunctionExit0( CFOLDERRENAMEDHARVESTER_HANDLEFOLDERRENAMEL_EXIT );
    }
// End of File