PECengine/ListLibrary2/ContactListSrc/CPEngContactListMngTransBase.cpp
branchRCL_3
changeset 17 a941bc465d9f
parent 0 094583676ce7
equal deleted inserted replaced
16:6ca72c0fe49a 17:a941bc465d9f
       
     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:  Base class of the contact list management handlers.
       
    15 *
       
    16 */
       
    17 
       
    18 #include "CPEngContactListMngTransBase.h"
       
    19 
       
    20 #include "CPEngContactListModChangeMonitor.h"
       
    21 #include "CPEngContactListSettings.h"
       
    22 
       
    23 #include "PEngListLibTools.h"
       
    24 #include "MPEngXMLSerializer.h"
       
    25 #include "MPEngXMLParser.h"
       
    26 #include "CPEngTransactionStatus.h"
       
    27 #include "PEngWVPresenceErrors2.h"
       
    28 #include "PresenceDebugPrint.h"
       
    29 
       
    30 #include <e32std.h>
       
    31 
       
    32 // ============================ MEMBER FUNCTIONS ===============================
       
    33 
       
    34 // -----------------------------------------------------------------------------
       
    35 // CPEngContactListMngTransBase::CPEngContactListMngTransBase()
       
    36 // -----------------------------------------------------------------------------
       
    37 //
       
    38 CPEngContactListMngTransBase::CPEngContactListMngTransBase(
       
    39     CPEngContactListModBase& aContactList,
       
    40     CPEngSessionSlotId& aSessionSlotId,
       
    41     TPEngWVCspVersion& aCSPVersion,
       
    42     TInt aOperationId )
       
    43         : iContactList( aContactList ),
       
    44         iSessionSlotId( aSessionSlotId ),
       
    45         iCSPVersion( aCSPVersion ),
       
    46         iOperationId( aOperationId )
       
    47     {
       
    48     iContactList.Open();                            // CSI: 65 #
       
    49     iContactList.Lock( EStorageLockLevelHigh );
       
    50     iContactList.BufferServerSideNotifications();
       
    51     }
       
    52 
       
    53 
       
    54 // -----------------------------------------------------------------------------
       
    55 // CPEngContactListMngTransBase::ConstructL()
       
    56 // -----------------------------------------------------------------------------
       
    57 //
       
    58 void CPEngContactListMngTransBase::ConstructL()
       
    59     {
       
    60     iTransactionStatus =  CPEngTransactionStatus::NewL();
       
    61     }
       
    62 
       
    63 
       
    64 // Destructor
       
    65 CPEngContactListMngTransBase::~CPEngContactListMngTransBase()
       
    66     {
       
    67     iContactList.ReleaseServerSideBuffering();
       
    68     iContactList.Unlock();
       
    69     iContactList.Close();
       
    70     delete iTransactionStatus;
       
    71     delete iRollBackIDsArray;
       
    72     }
       
    73 
       
    74 
       
    75 // ==============================================================================
       
    76 // =============Function from MPEngOutgoingTransactionHandler =================
       
    77 // ==============================================================================
       
    78 
       
    79 // -----------------------------------------------------------------------------
       
    80 // CPEngContactListMngTransBase::RequestL()
       
    81 // -----------------------------------------------------------------------------
       
    82 //
       
    83 void CPEngContactListMngTransBase::RequestL( TDes8& aSendBuffer )
       
    84     {
       
    85     // refresh contact from store
       
    86     aSendBuffer.Zero();
       
    87     MPEngXMLSerializer* xmlSerializer = CreateXmlSerializerL( aSendBuffer );
       
    88     CleanupClosePushL( *xmlSerializer );
       
    89 
       
    90     // <TransactionContent xmlns="http://www.wireless -village.org/TRC1.1">
       
    91     NListLibTools::AppendTransactionContentTagXmlL( *xmlSerializer, iCSPVersion );
       
    92 
       
    93     switch ( iUpdateState )
       
    94         {
       
    95         case EPEngListContentUpdate:
       
    96             {
       
    97             CPEngContactListMngTransBase::GetXMLContactListUpdateL( *xmlSerializer );
       
    98             break;
       
    99             }
       
   100 
       
   101         case EPEngSubscriptionUpdate:
       
   102             {
       
   103             DoGetXMLSubscriptionUpdateL( *xmlSerializer );
       
   104             break;
       
   105             }
       
   106 
       
   107         case EPEngRollBack:
       
   108             {
       
   109             CPEngContactListMngTransBase::GetXMLRollBackUpdateL( *xmlSerializer );
       
   110             break;
       
   111             }
       
   112 
       
   113         default:
       
   114             {
       
   115             User::Leave( KErrNotSupported );
       
   116             break;
       
   117             }
       
   118         }
       
   119 
       
   120     // end of transaction
       
   121     // </TransactionContent>
       
   122     xmlSerializer->EndTagL( KTransactionContent );
       
   123     CleanupStack::PopAndDestroy( ); // xmlSerializer
       
   124     }
       
   125 
       
   126 
       
   127 // -----------------------------------------------------------------------------
       
   128 // CPEngContactListMngTransBase::LastRunningTransactionHandler()
       
   129 // -----------------------------------------------------------------------------
       
   130 //
       
   131 void CPEngContactListMngTransBase::LastRunningTransactionHandler()
       
   132     {
       
   133     }
       
   134 
       
   135 
       
   136 // -----------------------------------------------------------------------------
       
   137 // CPEngContactListMngTransBase::ProcessResponseL()
       
   138 // -----------------------------------------------------------------------------
       
   139 //
       
   140 void CPEngContactListMngTransBase::ProcessResponseL(
       
   141     const TDesC8& aResponse,
       
   142     TRequestStatus& /* aStatus */ )
       
   143     {
       
   144     // is it list update response or subscription update response
       
   145     switch ( iUpdateState )
       
   146         {
       
   147         case EPEngListContentUpdate:
       
   148             {
       
   149             CPEngContactListMngTransBase::ParseListUpdateResponseL( aResponse );
       
   150             break;
       
   151             }
       
   152         case EPEngSubscriptionUpdate:
       
   153             {
       
   154             DoParseSubscriptionUpdateResponseL( aResponse );
       
   155             break;
       
   156             }
       
   157         case EPEngRollBack:
       
   158             {
       
   159             CPEngContactListMngTransBase::ParseListUpdateResponseL( aResponse );
       
   160             break;
       
   161             }
       
   162         default:
       
   163             {
       
   164             User::Leave( KErrNotSupported );
       
   165             }
       
   166         }
       
   167     }
       
   168 
       
   169 
       
   170 // -----------------------------------------------------------------------------
       
   171 // CPEngContactListMngTransBase::CancelProcessing()
       
   172 // -----------------------------------------------------------------------------
       
   173 //
       
   174 void CPEngContactListMngTransBase::CancelProcessing()
       
   175     {
       
   176     }
       
   177 
       
   178 
       
   179 // -----------------------------------------------------------------------------
       
   180 // CPEngContactListMngTransBase::NewTransactionHandlersL()
       
   181 // -----------------------------------------------------------------------------
       
   182 //
       
   183 void CPEngContactListMngTransBase::NewTransactionHandlersL(
       
   184     RPointerArray<MPEngOutgoingTransactionHandler>& /* aTransactionsArray*/ )
       
   185     {
       
   186     }
       
   187 
       
   188 
       
   189 // -----------------------------------------------------------------------------
       
   190 // CPEngContactListMngTransBase::TransactionCompleted()
       
   191 // -----------------------------------------------------------------------------
       
   192 //
       
   193 TBool CPEngContactListMngTransBase::TransactionCompleted()
       
   194     {
       
   195     return ( iUpdateState == EPEngTransactionCompleted );
       
   196     }
       
   197 
       
   198 
       
   199 // -----------------------------------------------------------------------------
       
   200 // CPEngGetWatchersTransaction::TransactionResult()
       
   201 // -----------------------------------------------------------------------------
       
   202 //
       
   203 CPEngTransactionStatus*  CPEngContactListMngTransBase::TransactionResult()
       
   204     {
       
   205     CPEngTransactionStatus* temp = iTransactionStatus;
       
   206     iTransactionStatus = NULL;
       
   207     return temp;
       
   208     }
       
   209 
       
   210 
       
   211 // -----------------------------------------------------------------------------
       
   212 // CPEngContactListMngTransBase::ReleaseHandler()
       
   213 // -----------------------------------------------------------------------------
       
   214 //
       
   215 void CPEngContactListMngTransBase::ReleaseHandler( )
       
   216     {
       
   217     iUpdateState = EPEngTransactionCompleted;
       
   218     }
       
   219 
       
   220 
       
   221 
       
   222 // =============================================================================
       
   223 // ===============Functions of main class ======================================
       
   224 // =============================================================================
       
   225 
       
   226 // -----------------------------------------------------------------------------
       
   227 // CPEngContactListMngTransBase::GetXMLContactListUpdateL()
       
   228 // -----------------------------------------------------------------------------
       
   229 //
       
   230 void CPEngContactListMngTransBase::GetXMLContactListUpdateL(
       
   231     MPEngXMLSerializer& aXmlSerializer )
       
   232     {
       
   233     // <ListManage-Request>
       
   234     aXmlSerializer.StartTagL( KListMnageRequest );
       
   235 
       
   236     NListLibTools::AppendContactListNameXmlL( aXmlSerializer, iContactList.Settings() );
       
   237 
       
   238     DoAppendListNickUpdateL( aXmlSerializer );
       
   239 
       
   240     // <ReceiveList>T</ReceiveList>
       
   241     NListLibTools::ApppendReceiveListTagL( aXmlSerializer, iCSPVersion, ETrue );
       
   242 
       
   243     // </ListManage-Request>
       
   244     aXmlSerializer.EndTagL( KListMnageRequest );
       
   245     }
       
   246 
       
   247 
       
   248 // -----------------------------------------------------------------------------
       
   249 // CPEngContactListMngTransBase::GetXMLRollBackUpdateL()
       
   250 // -----------------------------------------------------------------------------
       
   251 //
       
   252 void CPEngContactListMngTransBase::GetXMLRollBackUpdateL(
       
   253     MPEngXMLSerializer& aXmlSerializer )
       
   254     {
       
   255     // <ListManage-Request>
       
   256     aXmlSerializer.StartTagL( KListMnageRequest );
       
   257 
       
   258     NListLibTools::AppendContactListNameXmlL( aXmlSerializer, iContactList.Settings() );
       
   259 
       
   260     // <RemoveNickList>
       
   261     aXmlSerializer.StartTagL( KRemoveNickList );
       
   262 
       
   263     // insert contact Ids for rollback
       
   264     TInt count( iRollBackIDsArray->Count() );
       
   265     for ( TInt x( 0 ); x < count ; x++ )
       
   266         {
       
   267         // <UserID>
       
   268         // Contact list id value
       
   269         // </UserID>
       
   270         aXmlSerializer.StartTagL( KUserIDXMLTag
       
   271                                 ).WvAddressL( iRollBackIDsArray->MdcaPoint( x )
       
   272                                             ).EndTagL( KUserIDXMLTag );
       
   273         }
       
   274 
       
   275     // </RemoveNickList>
       
   276     aXmlSerializer.EndTagL( KRemoveNickList );
       
   277 
       
   278     // <ReceiveList>T</ReceiveList>
       
   279     NListLibTools::ApppendReceiveListTagL( aXmlSerializer, iCSPVersion, ETrue );
       
   280 
       
   281     // </ListManage-Request>
       
   282     aXmlSerializer.EndTagL( KListMnageRequest );
       
   283     }
       
   284 
       
   285 
       
   286 // -----------------------------------------------------------------------------
       
   287 // CPEngContactListMngTransBase::ParseListUpdateResponseL()
       
   288 // -----------------------------------------------------------------------------
       
   289 //
       
   290 void CPEngContactListMngTransBase::ParseListUpdateResponseL(
       
   291     const TDesC8& aResponse )
       
   292     {
       
   293     PENG_DP( D_PENG_LIT( "CPEngContactListMngTransBase::ParseListUpdateResponseL() [%S]" ),
       
   294              &( iContactList.ListProperties().Name() ) );
       
   295 
       
   296     // clean attribute models if this is roll back
       
   297     if ( iUpdateState == EPEngRollBack )
       
   298         {
       
   299         NListLibTools::DeactivatePresenceAttributesL( *iRollBackIDsArray, iSessionSlotId );
       
   300         }
       
   301 
       
   302     // consume response
       
   303     CPEngTransactionStatus* transactionStatus = CPEngTransactionStatus::NewL();
       
   304     CleanupClosePushL( *transactionStatus );
       
   305 
       
   306     MPEngXMLParser* xMLparser1 = CreateXMLParserLC();
       
   307     TInt err ( xMLparser1->ParseContactListResultL( aResponse,
       
   308                                                     iOperationId,
       
   309                                                     iContactList.StorageId(),
       
   310                                                     *transactionStatus ) );
       
   311 
       
   312     MPEngXMLParser* xMLparser2 = CreateXMLParserLC();
       
   313     switch ( err )
       
   314         {
       
   315         case KErrNone:
       
   316         case KPEngNwErrPartiallySuccessful:
       
   317             {
       
   318             // try to parse Nick list at any case, can be that Server is giving us
       
   319             // hook what is at the moment on the contact list
       
   320             // get one more parser for this part
       
   321             RReffArray<CPEngContactListModItemContainer> newContacts;
       
   322             CleanupClosePushL( newContacts );
       
   323             if ( NListLibTools::ParseContactListNickListL( aResponse,
       
   324                                                            newContacts,
       
   325                                                            iContactList,
       
   326                                                            *xMLparser1,
       
   327                                                            *xMLparser2,
       
   328                                                            ETrue,
       
   329                                                            &iNewIdsCount ) )
       
   330                 {
       
   331                 iContactList.AdoptNetworkViewL( newContacts );
       
   332                 // remove bad contacts from the
       
   333                 NListLibTools::RemoveBadContactsL( *transactionStatus, iContactList );
       
   334                 }
       
   335             else
       
   336                 {
       
   337                 // nick list was not there, consume result manually
       
   338                 NListLibTools::RemoveBadContactsL( *transactionStatus, iContactList );
       
   339                 // complete contact list update
       
   340                 DoCompleteContactListUpdateL();
       
   341                 }
       
   342 
       
   343             CleanupStack::PopAndDestroy(); // newContacts
       
   344             DoUpdateTransactionState();
       
   345             break;
       
   346             }
       
   347 
       
   348 
       
   349         case KPEngNwErrUnknownUser:
       
   350         case KPEngNwErrServiceUnavailable:
       
   351         case KPEngNwErrBadParameter:
       
   352         default:
       
   353             {
       
   354             iTransactionStatus->SetStatus( transactionStatus->Status() );
       
   355             transactionStatus->Reset();
       
   356 
       
   357             iUpdateState =  EPEngTransactionCompleted;
       
   358             //  fill manually transaction result
       
   359             RPointerArray<CPEngContactListModItemContainer> nickList;
       
   360             DoFillNickListLC( nickList );
       
   361             // go through array from end
       
   362             TInt contactCount ( nickList.Count() - 1 );
       
   363             for (  ; contactCount >= 0 ; --contactCount )
       
   364                 {
       
   365                 CPEngContactListModItemContainer* entry = nickList[ contactCount ];
       
   366 
       
   367 
       
   368                 // add bad contact it to the transaction status
       
   369                 TPtrC badContactId ( entry->Id() );
       
   370 
       
   371                 iTransactionStatus->AddDetailedResultL(
       
   372                     iOperationId,
       
   373                     KPEngNwErrUnknownUser,
       
   374                     NULL,
       
   375                     &badContactId,
       
   376                     &( iContactList.StorageId() ),
       
   377                     NULL );
       
   378 
       
   379                 if ( entry->IsFreshContact() )
       
   380                     {
       
   381                     iContactList.RemoveBadContactL( badContactId );
       
   382                     }
       
   383                 else
       
   384                     {
       
   385                     entry->RollBackNickname();
       
   386                     iContactList.StoreL();
       
   387                     }
       
   388                 }
       
   389 
       
   390             CleanupStack::PopAndDestroy(); // nickList
       
   391 
       
   392             // try to parse response if there was contact list content
       
   393             RReffArray<CPEngContactListModItemContainer> newContacts;
       
   394             CleanupClosePushL( newContacts );
       
   395             if ( NListLibTools::ParseContactListNickListL( aResponse,
       
   396                                                            newContacts,
       
   397                                                            iContactList,
       
   398                                                            *xMLparser1,
       
   399                                                            *xMLparser2,
       
   400                                                            ETrue ) )
       
   401                 {
       
   402                 iContactList.AdoptNetworkViewL( newContacts );
       
   403                 }
       
   404 
       
   405             CleanupStack::PopAndDestroy(); // newContacts
       
   406             break;
       
   407             }
       
   408         }
       
   409 
       
   410 
       
   411     // register new added contact Ids if this is subscription
       
   412     if ( ( iUpdateState == EPEngSubscriptionUpdate ) ||
       
   413          ( iUpdateState == EPEngActivateAttributes ) )
       
   414         {
       
   415         CPEngContactListModChangeMonitor& changeMonitor = iContactList.ChangeMonitor();
       
   416         NListLibTools::ActivatePresenceAttributesL( changeMonitor.AddedContactIds(),
       
   417                                                     iSessionSlotId );
       
   418         // update state if needed
       
   419         iUpdateState = ( iUpdateState == EPEngActivateAttributes ? EPEngTransactionCompleted
       
   420                          : iUpdateState );
       
   421         }
       
   422 
       
   423 
       
   424     // deactivate removed contact Ids if needed
       
   425     if ( iUpdateState == EPEngDeActivateAttributes )
       
   426         {
       
   427         CPEngContactListModChangeMonitor& changeMonitor = iContactList.ChangeMonitor();
       
   428         NListLibTools::DeactivatePresenceAttributesL( changeMonitor.RemovedContactIds(),
       
   429                                                       iSessionSlotId );
       
   430         iUpdateState = EPEngTransactionCompleted;
       
   431         }
       
   432 
       
   433 
       
   434     CleanupStack::PopAndDestroy( 2 ); // xMLparser2, xMLparser1
       
   435 
       
   436     iTransactionStatus->ImportStatusFrom( *transactionStatus );
       
   437     CleanupStack::Pop(); // transactionStatus
       
   438 
       
   439     PENG_DP( D_PENG_LIT( "CPEngContactListMngTransBase::ParseListUpdateResponseL() done [%S]" ),
       
   440              &( iContactList.ListProperties().Name() ) );
       
   441     }
       
   442 
       
   443 //  End of File
       
   444