phonebookui/Phonebook2/MMCExtension/src/CPmuCopyFromMmcCmd.cpp
changeset 0 e686773b3f54
equal deleted inserted replaced
-1:000000000000 0:e686773b3f54
       
     1 /*
       
     2 * Copyright (c) 2005-2007 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Phonebook 2 MMC UI extension copy from MMC command.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #include "cpmucopyfrommmccmd.h"
       
    20 
       
    21 // Phonebook2
       
    22 #include <mpbk2contactuicontrol.h>
       
    23 #include <mpbk2commandobserver.h>
       
    24 #include <pbk2processdecoratorfactory.h>
       
    25 #include <mpbk2processdecorator.h>
       
    26 #include <cpbk2storeconfiguration.h>
       
    27 #include <tpbk2copycontactsresults.h>
       
    28 #include <mpbk2contactnameformatter.h>
       
    29 #include <cpbk2storeproperty.h>
       
    30 #include <cpbk2storepropertyarray.h>
       
    31 #include <mpbk2storevalidityinformer.h>
       
    32 #include <mpbk2appui.h>
       
    33 #include <mpbk2applicationservices.h>
       
    34 #include <pbk2mmcuires.rsg>
       
    35 
       
    36 // Virtual Phonebook
       
    37 #include <mvpbkcontactoperationbase.h>
       
    38 #include <mvpbkstorecontact.h>
       
    39 #include <mvpbkcontactstorelist.h>
       
    40 #include <cvpbkvcardeng.h>
       
    41 #include <cvpbkcontactmanager.h>
       
    42 #include <tvpbkcontactstoreuriptr.h>
       
    43 #include <mvpbkcontactstore.h>
       
    44 #include <mvpbkcontactlinkarray.h>
       
    45 #include <vpbkcontactstoreuris.h>
       
    46 #include <mvpbkcontactstoreproperties.h>
       
    47 #include <cvpbkcontactstoreuriarray.h>
       
    48 
       
    49 // System includes
       
    50 #include <pathinfo.h>
       
    51 #include <stringloader.h>
       
    52 #include <aknnotewrappers.h>
       
    53 
       
    54 /// Unnamed namespace for local definitions
       
    55 namespace {
       
    56 
       
    57 const TInt KZero = 0;
       
    58 const TInt KOneContact = 1;
       
    59 
       
    60 enum TPmuCopyToMmcCmdState
       
    61     {
       
    62     EPmuCopyFromMmcCmdPrepare,
       
    63     EPmuCopyFromMmcCmdRun,
       
    64     EPmuCopyFromMmcCmdComplete    
       
    65     }; 
       
    66 
       
    67 #ifdef _DEBUG
       
    68 
       
    69 enum TPanicCode
       
    70     {
       
    71     EExecuteLD_PreCond = 1,
       
    72     EPanic_CopyNextL_OOB,
       
    73     EPanic_Wrong_State
       
    74     };
       
    75 
       
    76 void Panic(TInt aReason)
       
    77     {
       
    78     _LIT(KPanicText, "CPmuCopyFromMmcCmd");
       
    79     User::Panic(KPanicText, aReason);
       
    80     }
       
    81 #endif // _DEBUG
       
    82 
       
    83 /**
       
    84  * Shows store not available note.
       
    85  *
       
    86  * @param aStoreProperties      Store properties.
       
    87  */
       
    88 void ShowStoreNotAvailableNoteL( CPbk2StorePropertyArray& aStoreProperties )
       
    89     {
       
    90     CPbk2StoreConfiguration* storeConfig = CPbk2StoreConfiguration::NewL();
       
    91     CleanupStack::PushL( storeConfig );
       
    92     const TDesC& uri = storeConfig->DefaultSavingStoreL().UriDes();
       
    93 
       
    94     // Get the property of the default saving store
       
    95     const CPbk2StoreProperty* prop =
       
    96         aStoreProperties.FindProperty( uri );
       
    97     if ( prop && prop->StoreName().Length() > 0 )
       
    98         {
       
    99         HBufC* text = StringLoader::LoadLC( R_QTN_PHOB_STORE_NOT_AVAILABLE,
       
   100             prop->StoreName() );
       
   101         CAknInformationNote* note = new(ELeave) CAknInformationNote;
       
   102         // Show "not available" note
       
   103         note->ExecuteLD( *text );
       
   104         CleanupStack::PopAndDestroy( text );
       
   105         }
       
   106 
       
   107     CleanupStack::PopAndDestroy( storeConfig );
       
   108     }
       
   109 
       
   110 /**
       
   111  * Inspects is the store valid.
       
   112  *
       
   113  * @param aInfomer      Store validity informer.
       
   114  * @param aStore        Store to inspect.
       
   115  * @return  ETrue if the store is valid.s
       
   116  */
       
   117 TBool IsValidStoreL( MPbk2StoreValidityInformer& aInformer,
       
   118         MVPbkContactStore* aStore )
       
   119     {
       
   120     TBool isValid = EFalse;
       
   121 
       
   122     if ( aStore )
       
   123         {
       
   124         CVPbkContactStoreUriArray* currentlyValidStores =
       
   125             aInformer.CurrentlyValidStoresL();
       
   126         TVPbkContactStoreUriPtr uri =
       
   127             aStore->StoreProperties().Uri();
       
   128         isValid = currentlyValidStores->IsIncluded( uri );
       
   129         delete currentlyValidStores;
       
   130         }
       
   131     return isValid;
       
   132     }
       
   133 
       
   134 } /// namespace
       
   135 
       
   136 // --------------------------------------------------------------------------
       
   137 // CPmuCopyFromMmcCmd::CPmuCopyFromMmcCmd
       
   138 // --------------------------------------------------------------------------
       
   139 //
       
   140 CPmuCopyFromMmcCmd::CPmuCopyFromMmcCmd( MPbk2ContactUiControl& aUiControl ) :
       
   141         CActive( EPriorityStandard ),
       
   142         iUiControl( &aUiControl )
       
   143     {
       
   144     CActiveScheduler::Add( this );
       
   145     }
       
   146 
       
   147 // --------------------------------------------------------------------------
       
   148 // CPmuCopyFromMmcCmd::~CPmuCopyFromMmcCmd
       
   149 // --------------------------------------------------------------------------
       
   150 //
       
   151 CPmuCopyFromMmcCmd::~CPmuCopyFromMmcCmd()
       
   152     {
       
   153     Cancel();
       
   154 
       
   155     iReadStream.Close();
       
   156     delete iDir;
       
   157     delete iDecorator;
       
   158     delete iImportOperation;
       
   159     delete iVCardEngine;
       
   160     }
       
   161 
       
   162 // --------------------------------------------------------------------------
       
   163 // CPmuCopyFromMmcCmd::NewL
       
   164 // --------------------------------------------------------------------------
       
   165 //
       
   166 CPmuCopyFromMmcCmd* CPmuCopyFromMmcCmd::NewL
       
   167         ( MPbk2ContactUiControl& aUiControl )
       
   168     {
       
   169     CPmuCopyFromMmcCmd* self =
       
   170         new ( ELeave ) CPmuCopyFromMmcCmd( aUiControl );
       
   171     CleanupStack::PushL( self );
       
   172     self->ConstructL();
       
   173     CleanupStack::Pop( self );
       
   174     return self;
       
   175     }
       
   176 
       
   177 // --------------------------------------------------------------------------
       
   178 // CPmuCopyFromMmcCmd::ConstructL
       
   179 // --------------------------------------------------------------------------
       
   180 //
       
   181 inline void CPmuCopyFromMmcCmd::ConstructL()
       
   182     {
       
   183     iVCardEngine = CVPbkVCardEng::NewL
       
   184         ( Phonebook2::Pbk2AppUi()->ApplicationServices().ContactManager() );
       
   185     iDecorator = Pbk2ProcessDecoratorFactory::CreateProgressDialogDecoratorL
       
   186         ( R_PMU_COPY_PROGRESS_NOTE, EFalse );
       
   187 
       
   188     CPbk2StoreConfiguration* storeConfig = CPbk2StoreConfiguration::NewL();
       
   189     CleanupStack::PushL( storeConfig );
       
   190     iTargetStore = Phonebook2::Pbk2AppUi()->ApplicationServices().
       
   191             ContactManager().ContactStoresL().Find(
       
   192                 storeConfig->DefaultSavingStoreL() );
       
   193             
       
   194     CleanupStack::PopAndDestroy( storeConfig );
       
   195     
       
   196     // set the default contacts path
       
   197     iContactsPath = PathInfo::MemoryCardContactsPath();
       
   198     }
       
   199 
       
   200 // --------------------------------------------------------------------------
       
   201 // CPmuCopyFromMmcCmd::RunL
       
   202 // --------------------------------------------------------------------------
       
   203 //
       
   204 void CPmuCopyFromMmcCmd::RunL()
       
   205     {    
       
   206     switch ( iState )
       
   207         {
       
   208         case EPmuCopyFromMmcCmdPrepare:
       
   209             {
       
   210             if ( iUiControl )
       
   211                 {
       
   212                 // Blank UI control to get performance improvement
       
   213                 iUiControl->SetBlank( ETrue );
       
   214                 }
       
   215 
       
   216             iState = EPmuCopyFromMmcCmdRun;
       
   217             IssueRequest();
       
   218             break;
       
   219             }
       
   220 
       
   221         case EPmuCopyFromMmcCmdRun:
       
   222             {
       
   223             if ( iDir && iCurrentContactIndex < iDir->Count() )
       
   224                 {
       
   225                 CopyNextL();
       
   226                 }
       
   227             else
       
   228                 {
       
   229                 // decorator calls processdismissed
       
   230                 iDecorator->ProcessStopped();
       
   231                 }
       
   232             break;
       
   233             }
       
   234         case EPmuCopyFromMmcCmdComplete:
       
   235             {
       
   236             CommandCompletedL();
       
   237             break;
       
   238             }
       
   239         default:
       
   240             {
       
   241             __ASSERT_DEBUG( EFalse, Panic( EPanic_Wrong_State ) );
       
   242             break;
       
   243             }
       
   244         };
       
   245     
       
   246     }
       
   247 
       
   248 // --------------------------------------------------------------------------
       
   249 // CPmuCopyFromMmcCmd::DoCancel
       
   250 // --------------------------------------------------------------------------
       
   251 //
       
   252 void CPmuCopyFromMmcCmd::DoCancel()
       
   253     {
       
   254     delete iImportOperation;
       
   255     iImportOperation = NULL;
       
   256     }
       
   257 
       
   258 // --------------------------------------------------------------------------
       
   259 // CPmuCopyFromMmcCmd::RunError
       
   260 // --------------------------------------------------------------------------
       
   261 //
       
   262 TInt CPmuCopyFromMmcCmd::RunError( TInt /*aError*/ )
       
   263     {
       
   264     delete iImportOperation;
       
   265     iImportOperation = NULL;
       
   266     
       
   267     // decorator calls processdismissed
       
   268     iDecorator->ProcessStopped();
       
   269     
       
   270     return KErrNone;
       
   271     }
       
   272 
       
   273 // --------------------------------------------------------------------------
       
   274 // CPmuCopyFromMmcCmd::ExecuteLD
       
   275 // --------------------------------------------------------------------------
       
   276 //
       
   277 void CPmuCopyFromMmcCmd::ExecuteLD()
       
   278     {
       
   279     __ASSERT_DEBUG( iCommandObserver, Panic( EExecuteLD_PreCond ) );
       
   280 
       
   281     CleanupStack::PushL( this );
       
   282 
       
   283     if ( !iTargetStore ||
       
   284           !IsValidStoreL( Phonebook2::Pbk2AppUi()->ApplicationServices().
       
   285             StoreValidityInformer(), iTargetStore ) )
       
   286         {
       
   287         // if target store not available finish command
       
   288         ShowStoreNotAvailableNoteL
       
   289             ( Phonebook2::Pbk2AppUi()->ApplicationServices().StoreProperties() );
       
   290         CleanupStack::Pop(this);
       
   291         iCommandObserver->CommandFinished(*this);
       
   292         return;
       
   293         }
       
   294 
       
   295     Phonebook2::Pbk2AppUi()->ApplicationServices().ContactManager().
       
   296         FsSession().GetDir(
       
   297             iContactsPath,
       
   298             KEntryAttNormal | KEntryAttHidden | KEntryAttSystem,
       
   299             ESortNone,
       
   300             iDir );
       
   301 
       
   302     if ( iDir )
       
   303         {
       
   304         iDecorator->ProcessStartedL( iDir->Count() );
       
   305         iDecorator->SetObserver( *this );
       
   306         iCurrentContactIndex = 0;
       
   307         iCountOfContacts = 0;
       
   308 
       
   309         iState = EPmuCopyFromMmcCmdPrepare;
       
   310         IssueRequest();
       
   311         }
       
   312     else
       
   313         {
       
   314         ShowResultsL();
       
   315         iCommandObserver->CommandFinished( *this );
       
   316         }
       
   317 
       
   318     CleanupStack::Pop(this);
       
   319     }
       
   320 
       
   321 // --------------------------------------------------------------------------
       
   322 // CPmuCopyFromMmcCmd::AddObserver
       
   323 // --------------------------------------------------------------------------
       
   324 //
       
   325 void CPmuCopyFromMmcCmd::AddObserver( MPbk2CommandObserver& aObserver )
       
   326     {
       
   327     iCommandObserver = &aObserver;
       
   328     }
       
   329 
       
   330 // --------------------------------------------------------------------------
       
   331 // CPmuCopyFromMmcCmd::ResetUiControl
       
   332 // --------------------------------------------------------------------------
       
   333 //
       
   334 void CPmuCopyFromMmcCmd::ResetUiControl( MPbk2ContactUiControl& aUiControl )
       
   335     {
       
   336     if ( iUiControl == &aUiControl )
       
   337         {
       
   338         iUiControl->SetBlank( EFalse );
       
   339         iUiControl = NULL;
       
   340         }
       
   341     }
       
   342 
       
   343 // --------------------------------------------------------------------------
       
   344 // CPmuCopyFromMmcCmd::FieldAddedToContact
       
   345 // --------------------------------------------------------------------------
       
   346 //
       
   347 void CPmuCopyFromMmcCmd::FieldAddedToContact
       
   348         ( MVPbkContactOperationBase& /*aOperation*/ )
       
   349     {
       
   350     // This command does not operate on contact field level
       
   351     }
       
   352 
       
   353 // --------------------------------------------------------------------------
       
   354 // CPmuCopyFromMmcCmd::FieldAddingFailed
       
   355 // --------------------------------------------------------------------------
       
   356 //
       
   357 void CPmuCopyFromMmcCmd::FieldAddingFailed
       
   358         ( MVPbkContactOperationBase& /*aOperation*/, TInt /*aError*/ )
       
   359     {
       
   360     // This command does not operate on contact field level
       
   361     }
       
   362 
       
   363 // --------------------------------------------------------------------------
       
   364 // CPmuCopyFromMmcCmd::ContactsSaved
       
   365 // --------------------------------------------------------------------------
       
   366 //
       
   367 void CPmuCopyFromMmcCmd::ContactsSaved
       
   368         ( MVPbkContactOperationBase& aOperation,
       
   369           MVPbkContactLinkArray* aResults )
       
   370     {
       
   371     if ( &aOperation == iImportOperation )
       
   372         {
       
   373         ++iCountOfContacts;
       
   374         
       
   375         delete iImportOperation;
       
   376         iImportOperation = NULL;
       
   377         iReadStream.Close();
       
   378         IssueRequest();
       
   379         delete aResults;
       
   380         }
       
   381     }
       
   382 
       
   383 // --------------------------------------------------------------------------
       
   384 // CPmuCopyFromMmcCmd::ContactsSavingFailed
       
   385 // --------------------------------------------------------------------------
       
   386 //
       
   387 void CPmuCopyFromMmcCmd::ContactsSavingFailed
       
   388         ( MVPbkContactOperationBase& aOperation, TInt /*aError*/ )
       
   389     {
       
   390     if ( &aOperation == iImportOperation )
       
   391         {
       
   392         delete iImportOperation;
       
   393         iImportOperation = NULL;
       
   394         iReadStream.Close();
       
   395         IssueRequest();
       
   396         }
       
   397     }
       
   398 
       
   399 // --------------------------------------------------------------------------
       
   400 // CPmuCopyFromMmcCmd::ProcessDismissed
       
   401 // --------------------------------------------------------------------------
       
   402 //
       
   403 void CPmuCopyFromMmcCmd::ProcessDismissed( TInt /*aCancelCode*/ )
       
   404     {        
       
   405     Cancel();
       
   406 
       
   407     iState = EPmuCopyFromMmcCmdComplete;
       
   408     IssueRequest();
       
   409     }
       
   410 
       
   411 
       
   412 // --------------------------------------------------------------------------
       
   413 // CPmuCopyFromMmcCmd::CopyNextL
       
   414 // --------------------------------------------------------------------------
       
   415 //
       
   416 void CPmuCopyFromMmcCmd::CopyNextL()
       
   417     {
       
   418     __ASSERT_DEBUG( iDir->Count() > iCurrentContactIndex,
       
   419         EPanic_CopyNextL_OOB );
       
   420 
       
   421     TParse parse;
       
   422     parse.Set(( *iDir )[iCurrentContactIndex].iName,
       
   423         &iContactsPath,
       
   424         NULL );
       
   425 
       
   426     User::LeaveIfError( 
       
   427         iReadStream.Open( Phonebook2::Pbk2AppUi()->ApplicationServices().
       
   428             ContactManager().FsSession(), parse.FullName(), EFileRead ) );
       
   429     iImportOperation =
       
   430         iVCardEngine->ImportVCardL( *iTargetStore, iReadStream, *this );
       
   431     ++iCurrentContactIndex;
       
   432     iDecorator->ProcessAdvance( 1 );              
       
   433     }
       
   434 
       
   435 // --------------------------------------------------------------------------
       
   436 // CPmuCopyFromMmcCmd::IssueRequest
       
   437 // --------------------------------------------------------------------------
       
   438 //
       
   439 void CPmuCopyFromMmcCmd::IssueRequest()
       
   440     {
       
   441     if ( !IsActive() )
       
   442         {
       
   443         TRequestStatus* status = &iStatus;
       
   444         User::RequestComplete( status, KErrNone );
       
   445         SetActive();        
       
   446         }
       
   447     }
       
   448 
       
   449 // --------------------------------------------------------------------------
       
   450 // CPmuCopyFromMmcCmd::ShowResultsL
       
   451 // --------------------------------------------------------------------------
       
   452 //
       
   453 void CPmuCopyFromMmcCmd::ShowResultsL()
       
   454     {    
       
   455     if ( iDir )
       
   456         {
       
   457         const TInt contactCount = iDir->Count();
       
   458         if ( contactCount == KOneContact )
       
   459             {
       
   460             TParse parse;
       
   461             parse.Set( ( *iDir )[0].iName,
       
   462                 &iContactsPath,
       
   463                 NULL );
       
   464 
       
   465             TPbk2CopyContactsResults results
       
   466                 ( iCountOfContacts, parse.Name() );
       
   467             // If default saving store is not phone memory, show different
       
   468             // after copy note
       
   469             if ( !IsDefaultStorePhoneMemoryL() )
       
   470                 {
       
   471                 results.SetOneContactCopiedTextRes
       
   472                     ( R_QTN_PBCOP_NOTE_CONTACT_COPIED_PB2 );
       
   473                 }
       
   474             results.ShowNoteL();
       
   475             }
       
   476         else
       
   477             {
       
   478             TPbk2CopyContactsResults results(
       
   479                 iCountOfContacts, iDir->Count() );
       
   480             // If default saving store is not phone memory, show different
       
   481             // after copy note
       
   482             if ( !IsDefaultStorePhoneMemoryL() )
       
   483                 {
       
   484                 results.SetMultipleContactsCopiedTextRes
       
   485                     ( R_QTN_PBCOP_NOTE_N_ENTRY_COPY_PB );
       
   486                 }
       
   487             results.ShowNoteL();
       
   488             }
       
   489         }
       
   490     else
       
   491         {
       
   492         // The directory did not found, so the card migth be formatted.
       
   493         // Show "0 copied" note
       
   494         TPbk2CopyContactsResults results(
       
   495             iCountOfContacts, KZero );
       
   496         // If default saving store is not phone memory, show different
       
   497         // after copy note
       
   498         if ( !IsDefaultStorePhoneMemoryL() )
       
   499             {
       
   500             results.SetMultipleContactsCopiedTextRes
       
   501                 ( R_QTN_PBCOP_NOTE_N_ENTRY_COPY_PB );
       
   502             }
       
   503         results.ShowNoteL();
       
   504         }
       
   505     }
       
   506 
       
   507 // --------------------------------------------------------------------------
       
   508 // CPmuCopyFromMmcCmd::IsDefaultStorePhoneMemoryL
       
   509 // --------------------------------------------------------------------------
       
   510 //
       
   511 TBool CPmuCopyFromMmcCmd::IsDefaultStorePhoneMemoryL() const
       
   512     {
       
   513     TBool ret = EFalse;
       
   514 
       
   515     const TVPbkContactStoreUriPtr uri =
       
   516         Phonebook2::Pbk2AppUi()->ApplicationServices().
       
   517             StoreConfiguration().DefaultSavingStoreL();
       
   518 
       
   519     TVPbkContactStoreUriPtr phoneMemoryUri
       
   520         ( VPbkContactStoreUris::DefaultCntDbUri() );
       
   521 
       
   522     if ( uri.Compare( phoneMemoryUri,
       
   523         TVPbkContactStoreUriPtr::EContactStoreUriStoreType ) == 0 )
       
   524         {
       
   525         ret = ETrue;
       
   526         }
       
   527 
       
   528     return ret;
       
   529     }
       
   530 
       
   531 // --------------------------------------------------------------------------
       
   532 // CPmuCopyFromMmcCmd::CommandCompletedL
       
   533 // --------------------------------------------------------------------------
       
   534 //    
       
   535 void CPmuCopyFromMmcCmd::CommandCompletedL()
       
   536     {
       
   537     if (iUiControl)
       
   538         {
       
   539         iUiControl->SetBlank( EFalse );
       
   540         }
       
   541 
       
   542     ShowResultsL();
       
   543     
       
   544     if (iUiControl)
       
   545         {
       
   546         iUiControl->UpdateAfterCommandExecution();
       
   547         }
       
   548     
       
   549     if ( iCommandObserver )    
       
   550         {        
       
   551         iCommandObserver->CommandFinished( *this );
       
   552         }
       
   553     }
       
   554 
       
   555 // --------------------------------------------------------------------------
       
   556 // CPmuCopyFromMmcCmd::ShowMemorySelectionDialogL
       
   557 // --------------------------------------------------------------------------
       
   558 //
       
   559 TBool CPmuCopyFromMmcCmd::ShowMemorySelectionDialogL()
       
   560     {
       
   561     return EFalse;
       
   562     }
       
   563 
       
   564 // End of File