PECengine/ListLibrary2/ContactListSrc/CPEngStartSyncTransaction.cpp
changeset 0 094583676ce7
equal deleted inserted replaced
-1:000000000000 0:094583676ce7
       
     1 /*
       
     2 * Copyright (c) 2005 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:  Transction handler to do basic synchronization
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 // INCLUDE FILES
       
    20 #include "CPEngStartSyncTransaction.h"
       
    21 
       
    22 #include "MPEngContactListTransactionManager.h"
       
    23 #include "CPEngContactListSettings.h"
       
    24 #include "CPEngContactListModBase.h"
       
    25 
       
    26 #include "MPEngTransactionFactory.h"
       
    27 
       
    28 #include "PEngListLibTools.h"
       
    29 #include "MPEngXMLSerializer.h"
       
    30 #include "MPEngXMLParser.h"
       
    31 
       
    32 #include "PEngContactIdsTools.h"
       
    33 #include "CPEngTransactionStatus.h"
       
    34 #include "PEngWVPresenceErrors2.h"
       
    35 #include "PresenceDebugPrint.h"
       
    36 
       
    37 
       
    38 //Default granurality for list of lists
       
    39 const TInt KListOfListGranurality = 5;
       
    40 
       
    41 
       
    42 // ============================ MEMBER FUNCTIONS ===============================
       
    43 
       
    44 // -----------------------------------------------------------------------------
       
    45 // CPEngStartSyncTransaction::CPEngStartSyncTransaction()
       
    46 // -----------------------------------------------------------------------------
       
    47 //
       
    48 CPEngStartSyncTransaction::CPEngStartSyncTransaction(
       
    49     MPEngContactListTransactionManager& aCntLstSettingsManager,
       
    50     TPEngWVCspVersion& aCSPVersion,
       
    51     TInt aOperationId,
       
    52     TBool aNeedToUnsubscribe )
       
    53         : iContactListManager( aCntLstSettingsManager ),
       
    54         iSynchronizationState( EPEngGetListOfLists ),
       
    55         iServerCntLists( KListOfListGranurality ),
       
    56         iCSPVersion( aCSPVersion ),
       
    57         iOperationId( aOperationId ),
       
    58         iUnsubscribe( aNeedToUnsubscribe )
       
    59     {
       
    60     PENG_DP( D_PENG_LIT( "CPEngStartSyncTransaction::CPEngStartSyncTransaction()" ) );
       
    61     }
       
    62 
       
    63 
       
    64 // -----------------------------------------------------------------------------
       
    65 // CPEngStartSyncTransaction::ConstructL()
       
    66 // -----------------------------------------------------------------------------
       
    67 //
       
    68 void CPEngStartSyncTransaction::ConstructL()
       
    69     {
       
    70     iTransactionStatus =  CPEngTransactionStatus::NewL();
       
    71     }
       
    72 
       
    73 
       
    74 // -----------------------------------------------------------------------------
       
    75 // CPEngStartSyncTransaction::NewLC()
       
    76 // -----------------------------------------------------------------------------
       
    77 //
       
    78 CPEngStartSyncTransaction* CPEngStartSyncTransaction::NewLC(
       
    79     MPEngContactListTransactionManager& aCntLstSettingsManager,
       
    80     TPEngWVCspVersion& aCSPVersion,
       
    81     TInt aOperationId,
       
    82     TBool aNeedToUnsubscribe )
       
    83     {
       
    84     CPEngStartSyncTransaction* self = new ( ELeave ) CPEngStartSyncTransaction(
       
    85         aCntLstSettingsManager,
       
    86         aCSPVersion,
       
    87         aOperationId,
       
    88         aNeedToUnsubscribe );
       
    89 
       
    90     CleanupStack::PushL( self );
       
    91     self->ConstructL( );
       
    92 
       
    93     return self;
       
    94     }
       
    95 
       
    96 
       
    97 // Destructor
       
    98 CPEngStartSyncTransaction::~CPEngStartSyncTransaction()
       
    99     {
       
   100     PENG_DP( D_PENG_LIT( "CPEngStartSyncTransaction::~CPEngStartSyncTransaction()" ) );
       
   101     delete iTransactionStatus;
       
   102     iServerCntLists.Reset();
       
   103     delete iDefaultCntList;
       
   104     }
       
   105 
       
   106 
       
   107 // ==============================================================================
       
   108 // ============= Functions from MPEngOutgoingTransactionHandler =================
       
   109 // ==============================================================================
       
   110 
       
   111 // -----------------------------------------------------------------------------
       
   112 // CPEngStartSyncTransaction::RequestL()
       
   113 // -----------------------------------------------------------------------------
       
   114 //
       
   115 void CPEngStartSyncTransaction::RequestL( TDes8& aSendBuffer )
       
   116     {
       
   117     aSendBuffer.Zero();
       
   118     MPEngXMLSerializer* xmlSerializer = CreateXmlSerializerL( aSendBuffer );
       
   119     CleanupClosePushL( *xmlSerializer );
       
   120 
       
   121     // <TransactionContent xmlns="http://www.wireless -village.org/TRC1.1">
       
   122     NListLibTools::AppendTransactionContentTagXmlL( *xmlSerializer, iCSPVersion );
       
   123 
       
   124     switch ( iSynchronizationState )
       
   125         {
       
   126         case EPEngGetListOfLists:
       
   127             {
       
   128             GetXMLGetListOfContactListsL( *xmlSerializer );
       
   129             break;
       
   130             }
       
   131 
       
   132         case EPEngUnSubscribe:
       
   133             {
       
   134             GetXMLUnsubscribeAllL( *xmlSerializer );
       
   135             break;
       
   136             }
       
   137 
       
   138         default:
       
   139             {
       
   140             User::Leave( KErrCorrupt );
       
   141             break;
       
   142             }
       
   143         }
       
   144 
       
   145     // end of transaction
       
   146     // </TransactionContent>
       
   147     xmlSerializer->EndTagL( KTransactionContent );
       
   148     CleanupStack::PopAndDestroy( ); // xmlSerializer
       
   149     }
       
   150 
       
   151 
       
   152 // -----------------------------------------------------------------------------
       
   153 // CPEngStartSyncTransaction::LastRunningTransactionHandler()
       
   154 // -----------------------------------------------------------------------------
       
   155 //
       
   156 void CPEngStartSyncTransaction::LastRunningTransactionHandler()
       
   157     {
       
   158     }
       
   159 
       
   160 
       
   161 // -----------------------------------------------------------------------------
       
   162 // CPEngStartSyncTransaction::ProcessResponseL()
       
   163 // -----------------------------------------------------------------------------
       
   164 //
       
   165 void CPEngStartSyncTransaction::ProcessResponseL( const TDesC8& aResponse,
       
   166                                                   TRequestStatus& /* aStatus */ )
       
   167     {
       
   168     PENG_DP( D_PENG_LIT( "CPEngStartSyncTransaction::ProcessResponseL()" ) );
       
   169 
       
   170     // transaction to server was successful
       
   171     MPEngXMLParser* XMLparser = CreateXMLParserLC();
       
   172 
       
   173     switch ( iSynchronizationState )
       
   174         {
       
   175         case EPEngGetListOfLists:
       
   176             {
       
   177             ParseGetListOfListsResponseL( aResponse, XMLparser );
       
   178             break;
       
   179             }
       
   180 
       
   181         case EPEngUnSubscribe:
       
   182             {
       
   183             ParseUnsubscreAllResponseL( aResponse, XMLparser );
       
   184             break;
       
   185             }
       
   186 
       
   187         default:
       
   188             {
       
   189             User::Leave( KErrCorrupt );
       
   190             }
       
   191         }
       
   192 
       
   193     CleanupStack::PopAndDestroy(); // XMLparser
       
   194     }
       
   195 
       
   196 
       
   197 // -----------------------------------------------------------------------------
       
   198 // CPEngStartSyncTransaction::ProcessResponseL()
       
   199 // -----------------------------------------------------------------------------
       
   200 //
       
   201 void CPEngStartSyncTransaction::CancelProcessing()
       
   202     {
       
   203     }
       
   204 
       
   205 
       
   206 // -----------------------------------------------------------------------------
       
   207 // CPEngStartSyncTransaction::NewTransactionHandlersL()
       
   208 // -----------------------------------------------------------------------------
       
   209 //
       
   210 void CPEngStartSyncTransaction::NewTransactionHandlersL(
       
   211     RPointerArray<MPEngOutgoingTransactionHandler>& /*aTransactionsArray*/ )
       
   212     {
       
   213     }
       
   214 
       
   215 
       
   216 // -----------------------------------------------------------------------------
       
   217 // CPEngStartSyncTransaction::TransactionCompleted()
       
   218 // -----------------------------------------------------------------------------
       
   219 //
       
   220 TBool CPEngStartSyncTransaction::TransactionCompleted()
       
   221     {
       
   222     return ( iSynchronizationState == EPEngTransactionCompleted );
       
   223     }
       
   224 
       
   225 
       
   226 // -----------------------------------------------------------------------------
       
   227 // CPEngGetWatchersTransaction::TransactionResult()
       
   228 // -----------------------------------------------------------------------------
       
   229 //
       
   230 CPEngTransactionStatus*  CPEngStartSyncTransaction::TransactionResult()
       
   231     {
       
   232     CPEngTransactionStatus* temp = iTransactionStatus;
       
   233     iTransactionStatus = NULL;
       
   234     return temp;
       
   235     }
       
   236 
       
   237 
       
   238 // -----------------------------------------------------------------------------
       
   239 // CPEngStartSyncTransaction::ReleaseHandler()
       
   240 // -----------------------------------------------------------------------------
       
   241 //
       
   242 void CPEngStartSyncTransaction::ReleaseHandler()
       
   243     {
       
   244     iSynchronizationState = EPEngTransactionCompleted;
       
   245     }
       
   246 
       
   247 
       
   248 // -----------------------------------------------------------------------------
       
   249 // CPEngStartSyncTransaction::GetXMLContactListUpdateL()
       
   250 // -----------------------------------------------------------------------------
       
   251 //
       
   252 void CPEngStartSyncTransaction::GetXMLGetListOfContactListsL(
       
   253     MPEngXMLSerializer& aXmlSerializer )
       
   254     {
       
   255     // get lists of the contact lists of the server
       
   256     aXmlSerializer.StartTagL( KGetListOfList ).EndTagL( KGetListOfList );
       
   257     }
       
   258 
       
   259 // -----------------------------------------------------------------------------
       
   260 // CPEngStartSyncTransaction::GetXMLContactListUpdateL()
       
   261 // -----------------------------------------------------------------------------
       
   262 //
       
   263 void CPEngStartSyncTransaction::GetXMLUnsubscribeAllL(
       
   264     MPEngXMLSerializer& aXmlSerializer )
       
   265     {
       
   266     // <UnsubscribePresence-Request>
       
   267     aXmlSerializer.StartTagL( KUnsubscribePresence );
       
   268 
       
   269     // add all contact lists which are on the server
       
   270     TInt count( iServerCntLists.Count() );
       
   271     for ( TInt x( 0 ) ; x < count ; x++ )
       
   272         {
       
   273         // <ContactList>
       
   274         // append name of the contact list
       
   275         // </ContactList>
       
   276         aXmlSerializer.StartTagL( KContactList
       
   277                                 ).WvAddressL( iServerCntLists[ x ]
       
   278                                             ).EndTagL( KContactList );
       
   279         }
       
   280 
       
   281     //  </UnsubscribePresence-Request>
       
   282     aXmlSerializer.EndTagL( KUnsubscribePresence );
       
   283     }
       
   284 
       
   285 
       
   286 // -----------------------------------------------------------------------------
       
   287 // CPEngStartSyncTransaction::ParseGetListOfListsResponseL()
       
   288 // -----------------------------------------------------------------------------
       
   289 //
       
   290 void CPEngStartSyncTransaction::ParseGetListOfListsResponseL(
       
   291     const TDesC8& aResponse,
       
   292     MPEngXMLParser* aXMLparser )
       
   293     {
       
   294     iServerCntLists.Reset();
       
   295 
       
   296     // initialize to EFalse, we don't necessarily need the result
       
   297     TBool result( EFalse );
       
   298     aXMLparser->ParseResultL( aResponse,
       
   299                               iOperationId,
       
   300                               *iTransactionStatus,
       
   301                               result );
       
   302 
       
   303     //if it was found anyway
       
   304     if ( result )
       
   305         {
       
   306         iSynchronizationState = EPEngTransactionCompleted;
       
   307         return;
       
   308         }
       
   309 
       
   310     // Is there default contact list
       
   311     if ( aXMLparser->DecodeL( aResponse, KDefaultContactList, EFalse ) )
       
   312         {
       
   313         iDefaultCntList = aXMLparser->ResultAsUnicodeTextL();
       
   314         iDefaultCntList->Des().Fold();
       
   315         iServerCntLists.AppendL( *iDefaultCntList );
       
   316         }
       
   317     else
       
   318         {
       
   319         iDefaultCntList = KNullDesC().AllocL();
       
   320         }
       
   321 
       
   322 
       
   323     const TDesC& domain = iContactListManager.UserDomain();
       
   324     if ( aXMLparser->DecodeL( aResponse, KContactList, EFalse ) )
       
   325         {
       
   326         TInt countResults( aXMLparser->Count() );
       
   327         for ( TInt i( 0 ) ; i < countResults; ++i )
       
   328             {
       
   329             // convert to 16 unicode
       
   330             HBufC16* listName = aXMLparser->ResultAsUnicodeTextL( i );
       
   331             CleanupStack::PushL( listName );
       
   332             listName->Des().Fold();
       
   333             NContactIdsTools::AddContactIdToArrayL( iServerCntLists,
       
   334                                                     *listName,
       
   335                                                     domain );
       
   336             CleanupStack::PopAndDestroy();
       
   337             }
       
   338         }
       
   339 
       
   340     if ( iUnsubscribe )
       
   341         {
       
   342         iSynchronizationState = EPEngUnSubscribe;
       
   343         }
       
   344     else
       
   345         {
       
   346         iSynchronizationState = EPEngTransactionCompleted;
       
   347         iContactListManager.CompleteEnviromentSyncL( iServerCntLists,
       
   348                                                      KNullDesC,
       
   349                                                      EFalse );
       
   350         }
       
   351     }
       
   352 
       
   353 
       
   354 // -----------------------------------------------------------------------------
       
   355 // CPEngStartSyncTransaction::ParseUnsubscreAllResponseL()
       
   356 // -----------------------------------------------------------------------------
       
   357 //
       
   358 void CPEngStartSyncTransaction::ParseUnsubscreAllResponseL(
       
   359     const TDesC8& aResponse,
       
   360     MPEngXMLParser* aXMLparser )
       
   361     {
       
   362     CPEngTransactionStatus* transactionStatus = CPEngTransactionStatus::NewL();
       
   363     CleanupClosePushL( *transactionStatus );
       
   364     TInt err ( aXMLparser->ParseResultL( aResponse,
       
   365                                          iOperationId,
       
   366                                          *transactionStatus ) );
       
   367 
       
   368     switch ( err )
       
   369         {
       
   370         case KErrNone:
       
   371             {
       
   372             break;
       
   373             }
       
   374 
       
   375 
       
   376         case KPEngNwErrPartiallySuccessful:
       
   377             {
       
   378             // partially success
       
   379             // remove not existing contact lists, though, should not happen
       
   380             TInt count ( transactionStatus->DetailedResultCount() );
       
   381             for ( TInt x ( 0 ) ; x < count ; x++ )
       
   382                 {
       
   383                 const MPEngDetailedResultEntry2& detailedResult =
       
   384                     transactionStatus->DetailedResult( x );
       
   385 
       
   386                 // ignore if there are some errors, except wrong contact list
       
   387                 if ( detailedResult.Error() == KPEngNwErrContactListDoesNotExist )
       
   388                     {
       
   389                     // not existing contact list, remove it from list
       
   390                     // of server lists
       
   391                     TPtrC wrongContactLst;
       
   392                     detailedResult.GetDetailedDesc( wrongContactLst,
       
   393                                                     EPEngDTContactListID );
       
   394                     TInt pos( KErrNotFound );
       
   395                     if ( KErrNone == iServerCntLists.Find( wrongContactLst, pos ) )
       
   396                         {
       
   397                         iServerCntLists.Delete( pos );
       
   398                         }
       
   399                     }
       
   400                 }
       
   401 
       
   402             break;
       
   403             }
       
   404 
       
   405 
       
   406         case KPEngNwErrContactListDoesNotExist:
       
   407             {
       
   408             iServerCntLists.Reset();
       
   409             delete iDefaultCntList;
       
   410             iDefaultCntList = NULL;
       
   411             iDefaultCntList = KNullDesC().AllocL();
       
   412             break;
       
   413             }
       
   414 
       
   415         default:
       
   416             {
       
   417             break;
       
   418             }
       
   419         }
       
   420 
       
   421     iTransactionStatus->ImportStatusFrom( *transactionStatus );
       
   422     CleanupStack::Pop( ); // transactionStatus
       
   423 
       
   424     iContactListManager.CompleteEnviromentSyncL( iServerCntLists,
       
   425                                                  *iDefaultCntList,
       
   426                                                  ETrue );
       
   427 
       
   428     iSynchronizationState = EPEngTransactionCompleted;
       
   429     }
       
   430 
       
   431 //  End of File