xdmprotocols/XcapProtocol/src/XcapDirectory.cpp
branchRCL_3
changeset 35 fbd2e7cec7ef
parent 0 c8caa15ef882
equal deleted inserted replaced
34:2669f8761a99 35:fbd2e7cec7ef
       
     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: CXcapDirectory
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 // INCLUDE FILES
       
    22 #include <utf.h>
       
    23 #include <f32file.h>
       
    24 #include "XcapAppUsageDef.h"
       
    25 #include "XdmProtocol.h"
       
    26 #include "XcapDocument.h"
       
    27 #include "XcapProtocol.h"
       
    28 #include "XcapAppUsage.h"
       
    29 #include "XcapRetrieval.h"
       
    30 #include "XcapDirectory.h"
       
    31 #include "XdmXmlParser.h"
       
    32 #include "XcapHttpReqGet.h"
       
    33 #include "XdmDocumentNode.h"
       
    34 #include "XdmNodeAttribute.h"
       
    35 #include "XcapHttpTransport.h"
       
    36 #include "XdmOperationFactory.h"
       
    37 
       
    38 // ----------------------------------------------------------
       
    39 // CXcapDirectory::CXcapDirectory
       
    40 // 
       
    41 // ----------------------------------------------------------
       
    42 //
       
    43 CXcapDirectory::CXcapDirectory( CXdmDocument*& aDirectoryDoc,
       
    44                                 CXdmEngine& aXdmEngine,
       
    45                                 CXcapProtocol& aXcapProtocol ) :
       
    46                                 CXdmDirectory( aXdmEngine ),
       
    47                                 iDirectoryDoc( ( CXcapDocument* )aDirectoryDoc ),
       
    48                                 iXcapProtocol( aXcapProtocol )                                             
       
    49     { 
       
    50     }
       
    51 
       
    52 // ----------------------------------------------------------
       
    53 // CXcapDirectory::NewL
       
    54 // 
       
    55 // ----------------------------------------------------------
       
    56 //
       
    57 CXcapDirectory* CXcapDirectory::NewL( const TDesC& aAUID,
       
    58                                       CXdmEngine& aXdmEngine,
       
    59                                       CXdmDocument*& aDirectoryDoc,
       
    60                                       CXcapProtocol& aXcapProtocol )
       
    61     {
       
    62     CXcapDirectory* self = new ( ELeave ) CXcapDirectory( aDirectoryDoc, aXdmEngine, aXcapProtocol );
       
    63     CleanupStack::PushL( self );
       
    64     self->ConstructL( aAUID );
       
    65     CleanupStack::Pop();
       
    66     return self;
       
    67     }
       
    68 
       
    69 // ----------------------------------------------------
       
    70 // CXcapDirectory::~CXcapDirectory
       
    71 // 
       
    72 // ----------------------------------------------------
       
    73 //
       
    74 CXcapDirectory::~CXcapDirectory()
       
    75     {
       
    76     #ifdef _DEBUG
       
    77         iXcapProtocol.WriteToLog( _L8( "CXcapDirectory::~CXcapDirectory()" ) );
       
    78     #endif
       
    79     Cancel();
       
    80     delete iAUID;
       
    81     delete iDirectoryDoc;
       
    82     delete iHttpRetrieval;
       
    83     iUpdateList.Close();
       
    84     iDocumentList.Close();
       
    85     }
       
    86     
       
    87 // ----------------------------------------------------------
       
    88 // CXcapDirectory::ConstructL
       
    89 // 
       
    90 // ----------------------------------------------------------
       
    91 //
       
    92 void CXcapDirectory::ConstructL( const TDesC& aAUID )
       
    93     {
       
    94     if( aAUID.Length() > 0 )
       
    95         {
       
    96         _LIT( KNodePath,    "xcap-directory/folder" );
       
    97         iAUID = HBufC::NewL( aAUID.Length() );
       
    98         iAUID->Des().Copy( aAUID );
       
    99         CXdmDocumentNode* node = iDirectoryDoc->DocumentSubsetL( KNodePath );
       
   100         CleanupStack::PushL( node );
       
   101         CXdmNodeAttribute* auid = node->CreateAttributeL( KAuidAttribute );
       
   102         CleanupStack::PushL( auid );
       
   103         auid->SetAttributeValueL( aAUID );
       
   104         iDirectoryDoc->FetchDataL( node );
       
   105         //Set the option that prohibits caching
       
   106         iDirectoryDoc->SetOption( KXdmOption3 );
       
   107         CleanupStack::Pop( 2 );  //auid, node
       
   108         }
       
   109     else iDirectoryDoc->FetchDataL();
       
   110     CActiveScheduler::Add( this );
       
   111     }
       
   112 
       
   113 // ----------------------------------------------------------
       
   114 // CXcapDirectory::StartUpdateL
       
   115 // 
       
   116 // ----------------------------------------------------------
       
   117 //
       
   118 void CXcapDirectory::StartUpdateL()
       
   119     
       
   120     {
       
   121     #ifdef _DEBUG
       
   122         iXcapProtocol.WriteToLog( _L8( "CXcapDirectory::StartUpdateL()" ) );
       
   123     #endif
       
   124     switch( iUpdatePhase )
       
   125         {
       
   126         case EDirPhaseIdle:
       
   127             User::RequestComplete( iClientStatus, KErrArgument );
       
   128             break;
       
   129         case EUpdateDocumentList:
       
   130             HandleDocumentListRequestL();
       
   131             break;
       
   132         case ERefreshDocuments:
       
   133             HandleRefreshRequestL();
       
   134             break;
       
   135         default:
       
   136             break;
       
   137         } 
       
   138     }
       
   139 
       
   140 // ----------------------------------------------------------
       
   141 // CXcapDirectory::SaveRequestData
       
   142 // 
       
   143 // ----------------------------------------------------------
       
   144 //
       
   145 void CXcapDirectory::SaveRequestData( TDirUpdatePhase aUpdatePhase,
       
   146                                       TRequestStatus& aClientStatus )
       
   147     {
       
   148     iUpdatePhase = aUpdatePhase;
       
   149     iClientStatus = &aClientStatus;
       
   150     }
       
   151     
       
   152 // ----------------------------------------------------
       
   153 // CXcapDirectory::HandleDocumentListRequestL
       
   154 // 
       
   155 // ----------------------------------------------------
       
   156 //
       
   157 void CXcapDirectory::HandleDocumentListRequestL()
       
   158     {
       
   159     #ifdef _DEBUG
       
   160         iXcapProtocol.WriteToLog( _L8( "CXcapDirectory::HandleDocumentListRequestL()" ) );
       
   161     #endif
       
   162     if( !IsActive() )
       
   163         {
       
   164         CXcapDocument* doc = ( CXcapDocument* )iDirectoryDoc;
       
   165         doc->StartInternalL( iStatus );
       
   166         iUpdatePhase = EUpdateDocumentList;
       
   167         SetActive();
       
   168         }
       
   169     }
       
   170     
       
   171 // ----------------------------------------------------
       
   172 // CXcapDirectory::HandleRefreshRequestL
       
   173 // 
       
   174 // ----------------------------------------------------
       
   175 //
       
   176 void CXcapDirectory::HandleRefreshRequestL()
       
   177     {
       
   178     #ifdef _DEBUG
       
   179         iXcapProtocol.WriteToLog( _L8( "CXcapDirectory::HandleRefreshRequestL()" ) );
       
   180     #endif
       
   181     if( iUpdatePhase == EUpdateDocumentList )
       
   182         {
       
   183         if( iUpdateList.Count() > 0 )
       
   184             {
       
   185             iUpdateIndex = -1;
       
   186             iHttpRetrieval = iXcapProtocol.Transport().GetL( TPtrC() );
       
   187             UpdateNextDocumentL();
       
   188             iUpdatePhase = ERefreshDocuments;
       
   189             }
       
   190         else
       
   191             {
       
   192             #ifdef _DEBUG
       
   193                 iXcapProtocol.WriteToLog( _L8( "  All documents are up to date" ) );
       
   194             #endif
       
   195             User::RequestComplete( iClientStatus, KErrNone );
       
   196             }
       
   197         }
       
   198     else
       
   199         {
       
   200         #ifdef _DEBUG
       
   201             iXcapProtocol.WriteToLog( _L8( "  Wrong state [%d]" ), iUpdatePhase );
       
   202         #endif
       
   203         User::RequestComplete( iClientStatus, KErrNotReady );
       
   204         }
       
   205     }
       
   206 
       
   207 // ----------------------------------------------------
       
   208 // CXcapDirectory::UpdateNextDocumentL
       
   209 // 
       
   210 // ----------------------------------------------------
       
   211 //
       
   212 void CXcapDirectory::UpdateNextDocumentL()
       
   213     {
       
   214     #ifdef _DEBUG
       
   215         iXcapProtocol.WriteToLog( _L8( "CXcapDirectory::UpdateNextDocumentL()" ) );
       
   216     #endif
       
   217     iUpdateIndex++;
       
   218     if( iUpdateIndex < iUpdateList.Count() )
       
   219         {
       
   220         CXdmDocumentNode* node = iUpdateList[iUpdateIndex];
       
   221         #ifdef _DEBUG
       
   222             iXcapProtocol.WriteToLog( _L8( "  Index: %d  Document: %x" ), iUpdateIndex, node );
       
   223         #endif
       
   224         TPtrC8 root = iXcapProtocol.Transport().RootUri();
       
   225         TPtrC docUri( ExtractDocumentUriL( root, node ) );
       
   226         HBufC* uri = HBufC::NewLC( root.Length() + docUri.Length() );
       
   227         uri->Des().Copy( root );
       
   228         uri->Des().Append( docUri );
       
   229         iHttpRetrieval->ResetUriL( uri->Des() );
       
   230         iHttpRetrieval->SetExpiryTimeL( NULL, KDefaultHttpRequestTimeout * 1000000 );
       
   231         iHttpRetrieval->DispatchRequestL( iStatus );
       
   232         CleanupStack::PopAndDestroy();  //uri
       
   233         SetActive();
       
   234         }
       
   235     else
       
   236         {
       
   237         #ifdef _DEBUG
       
   238             iXcapProtocol.WriteToLog( _L8( "  Directory sync complete" ) );
       
   239         #endif
       
   240         User::RequestComplete( iClientStatus, KErrNone );
       
   241         }
       
   242     }
       
   243 
       
   244 // ---------------------------------------------------------
       
   245 // CXcapDirectory::RunL()
       
   246 // 
       
   247 // ---------------------------------------------------------
       
   248 //
       
   249 void CXcapDirectory::RunL()
       
   250     {
       
   251     #ifdef _DEBUG
       
   252         iXcapProtocol.WriteToLog( _L8( "CXcapDirectory::RunL() - Request: %d" ), iStatus.Int() );
       
   253     #endif
       
   254     if( iStatus == KErrNone )
       
   255         {
       
   256         switch( iUpdatePhase )
       
   257             {
       
   258             case EUpdateDocumentList:
       
   259                 {
       
   260                 iDocumentCount = iDirectoryDoc->Find( KDirectoryEntry, iDocumentList );
       
   261                 if( iDocumentCount > 0 )
       
   262                     {
       
   263                     TInt index = 0;
       
   264                     while( index < iDocumentCount )
       
   265                         {
       
   266                         TBool uptodate = CheckLocalCopyL( iDocumentList[index] );
       
   267                         #ifdef _DEBUG
       
   268                             iXcapProtocol.WriteToLog( _L8( "  Cache: %d" ), uptodate );
       
   269                         #endif
       
   270                         if( !uptodate )
       
   271                             User::LeaveIfError( iUpdateList.Append( iDocumentList[index] ) );
       
   272                         index++;
       
   273                         }
       
   274                     }
       
   275                 User::RequestComplete( iClientStatus, iStatus.Int() );
       
   276                 }
       
   277                 break;
       
   278             case ERefreshDocuments:
       
   279                 {
       
   280                 CXdmDocumentNode* node = iUpdateList[iUpdateIndex];
       
   281                 #ifdef _DEBUG
       
   282                     iXcapProtocol.WriteToLog( _L8( "  Index:    %d" ), iUpdateIndex );
       
   283                     iXcapProtocol.WriteToLog( _L8( "  Document: %x" ), node );
       
   284                     iXcapProtocol.WriteToLog( _L8( "  Error:    %d" ), iStatus.Int() );
       
   285                 #endif
       
   286                 TPtrC8 root = iXcapProtocol.Transport().RootUri();
       
   287                 TPtrC docName = ExtractDocumentUriL( root, node );
       
   288                 TXdmCompletionData* data = iHttpRetrieval->ResponseData();
       
   289                 TPtrC8 responseData( data->iResponseData->Des() );
       
   290                 TPtrC8 eTag( data->iETag->Des() );
       
   291                 RXcapCache* cache = iXcapProtocol.Cache();
       
   292                 cache->Store( eTag, docName, root, responseData  );
       
   293                 iHttpRetrieval->ReleaseResponseData();
       
   294                 UpdateNextDocumentL();
       
   295                 }
       
   296                 break;
       
   297             default:
       
   298                 #ifdef _DEBUG
       
   299                     iXcapProtocol.WriteToLog( _L8( "  Default case, unknown state %d - Status: %d" ),
       
   300                                                iUpdatePhase, iStatus.Int() );
       
   301                 #endif
       
   302                 if( iClientStatus != NULL )
       
   303                     User::RequestComplete( iClientStatus, KErrUnknown );  
       
   304                 break;
       
   305             }   
       
   306         }
       
   307     else
       
   308         {
       
   309         #ifdef _DEBUG
       
   310             iXcapProtocol.WriteToLog( _L8( "  Operation failed with %d" ), iStatus.Int() );
       
   311         #endif
       
   312         User::RequestComplete( iClientStatus, iStatus.Int() );
       
   313         }
       
   314     }
       
   315 
       
   316 // ---------------------------------------------------------
       
   317 // CXcapDirectory::CheckLocalCopyL
       
   318 // 
       
   319 // ---------------------------------------------------------
       
   320 //
       
   321 TBool CXcapDirectory::CheckLocalCopyL( const CXdmDocumentNode* aDocumentNode )
       
   322     {
       
   323     /*#ifdef _DEBUG
       
   324         iXcapProtocol.WriteToLog( _L8( "CXcapDirectory::CheckLocalCopyL()" ) );
       
   325     #endif*/
       
   326     TBool ret = EFalse;
       
   327     TPtrC8 root = iXcapProtocol.Transport().RootUri();
       
   328     TPtrC docName = ExtractDocumentUriL( root, aDocumentNode );
       
   329     TPtrC etag( aDocumentNode->Attribute( KDocumentETag )->AttributeValue() );
       
   330     HBufC8* etag8 = CnvUtfConverter::ConvertFromUnicodeToUtf8L( etag );
       
   331     CleanupStack::PushL( etag8 );
       
   332     RXcapCache* cache = iXcapProtocol.Cache();
       
   333     ret = cache != NULL ? cache->IsCurrent( etag8->Des(), docName, root ) == KErrNone : ETrue;
       
   334     CleanupStack::PopAndDestroy();  //etag8
       
   335     return ret;
       
   336     }
       
   337 
       
   338 // ---------------------------------------------------------
       
   339 // CXcapDirectory::ExtractDocumentUriL
       
   340 // 
       
   341 // ---------------------------------------------------------
       
   342 //
       
   343 TPtrC CXcapDirectory::ExtractDocumentUriL( const TDesC8& aRootUri,
       
   344                                            const CXdmDocumentNode* aDocumentNode )
       
   345     {
       
   346     /*#ifdef _DEBUG
       
   347         iXcapProtocol.WriteToLog( _L8( "CXcapDirectory::ExtractDocumentUri()" ) );
       
   348     #endif*/
       
   349     const TUint8 KHttpHostSeparator = 47;
       
   350     _LIT8( KHttpDoubleHostSeparator,  "//" );
       
   351     TPtrC uri( aDocumentNode->Attribute( KDocumentUri )->AttributeValue() );
       
   352     if( uri[0] == KHttpHostSeparator ) //Relative URI
       
   353         return uri;
       
   354     else
       
   355         {
       
   356         TInt index = aRootUri.Find( KHttpDoubleHostSeparator );
       
   357         TPtrC8 root( aRootUri.Right( aRootUri.Length() - index - 2 ) );
       
   358         HBufC8* uri8 = CnvUtfConverter::ConvertFromUnicodeToUtf8L( uri );
       
   359         CleanupStack::PushL( uri8 );
       
   360         TPtr8 desc( uri8->Des() );
       
   361         index = desc.Find( root );
       
   362         CleanupStack::PopAndDestroy();  //uri8
       
   363         return index >= 0 ? uri.Right( uri.Length() - root.Length() - index ) : TPtrC();
       
   364         }
       
   365     }
       
   366 
       
   367 // ----------------------------------------------------
       
   368 // CXcapDirectory::DocumentCount
       
   369 // 
       
   370 // ----------------------------------------------------
       
   371 //
       
   372 TInt CXcapDirectory::DocumentCount()
       
   373     {
       
   374     return iDocumentCount;
       
   375     }
       
   376 
       
   377 // ----------------------------------------------------
       
   378 // CXcapDirectory::DocumentType
       
   379 // 
       
   380 // ----------------------------------------------------
       
   381 //
       
   382 TXdmDocType CXcapDirectory::DocumentTypeL( TInt aIndex ) const
       
   383     {
       
   384     TXdmDocType type = EXdmDocGeneral;
       
   385     if( iUpdatePhase <= EDirPhaseIdle )
       
   386         User::Leave( KErrNotReady );
       
   387     else if( iDocumentCount > 0 && ( aIndex >= 0 && aIndex < iDocumentCount ) )
       
   388         type = FindAUID( *iDocumentList[aIndex] );
       
   389     return type;
       
   390     } 
       
   391 
       
   392 // ----------------------------------------------------
       
   393 // CXcapDirectory::FindAUID
       
   394 // 
       
   395 // ----------------------------------------------------
       
   396 //
       
   397 TXdmDocType CXcapDirectory::FindAUID( const CXdmDocumentNode& aEntryNode ) const
       
   398     {
       
   399     TXdmDocType documentType = EXdmDocGeneral;
       
   400     HBufC8* buf = aEntryNode.Attribute( KDocumentUri )->EightBitValueLC();
       
   401     if( buf )
       
   402         {
       
   403         TPtrC8 uri( buf->Des() );
       
   404         if( uri.Find( KXdmCapabilityUsageAUID ) >= 0 )
       
   405             documentType = EXdmCapabilities;
       
   406         else if( uri.Find( KXdmPocUserAccessUsageAUID ) >= 0 )
       
   407             documentType = EXdmPoCUserAccessPolicy;
       
   408         else if( uri.Find( KXdmPocGroupUsageAUID ) >= 0 )
       
   409             documentType = EXdmPoCGroup;
       
   410         else if( uri.Find( KXdmResourceListsUsageAUID ) >= 0 )
       
   411             documentType = EXdmResourceLists;
       
   412         else if( uri.Find( KXdmOmaPresRulesUsageAUID ) >= 0 )
       
   413             documentType = EXdmIetfPresenceRules;
       
   414         else if( uri.Find( KXdmDirectoryUsageAUID ) >= 0 )
       
   415             documentType = EXdmDirectory;
       
   416         else if( uri.Find( KXdmSharedXDMUsageAUID ) >= 0 )
       
   417             documentType = EXdmSharedXdm;
       
   418         else if( uri.Find( KXdmRlsServicesUsageAUID ) >= 0 )
       
   419             documentType = EXdmRlsServices;
       
   420         CleanupStack::PopAndDestroy();  //EightBitValueLC()
       
   421         }
       
   422     return documentType;
       
   423     }
       
   424                  
       
   425 // ----------------------------------------------------
       
   426 // CXcapDirectory::Document
       
   427 // 
       
   428 // ----------------------------------------------------
       
   429 //
       
   430 TPtrC CXcapDirectory::Document( TInt aIndex ) const
       
   431     {
       
   432     #ifdef _DEBUG
       
   433         iXcapProtocol.WriteToLog( _L8( "CXcapDirectory::Document() - Index: %d" ), aIndex );
       
   434     #endif
       
   435     TChar slash = 47;
       
   436     if( aIndex >= 0 && aIndex < iDocumentList.Count() ) 
       
   437         {
       
   438         TPtrC ret;
       
   439         TPtrC uri = iDocumentList[aIndex]->Attribute( KDocumentUri )->AttributeValue();
       
   440         TInt index = uri.LocateReverse( slash );
       
   441         index > 0 ? ret.Set( uri.Right( uri.Length() - index - 1 ) ) : ret.Set( uri );
       
   442         return ret;
       
   443         }
       
   444     else return TPtrC();
       
   445     }
       
   446         
       
   447 // ----------------------------------------------------
       
   448 // CXcapDirectory::DirectoryPath
       
   449 // 
       
   450 // ----------------------------------------------------
       
   451 //
       
   452 TPtrC CXcapDirectory::DirectoryPath() const
       
   453     {
       
   454     return iAUID != NULL ? iAUID->Des() : TPtrC();
       
   455     }
       
   456 
       
   457 // ----------------------------------------------------
       
   458 // CXcapDirectory::CancelUpdate
       
   459 // 
       
   460 // ----------------------------------------------------
       
   461 //
       
   462 void CXcapDirectory::CancelUpdate()
       
   463     {
       
   464     #ifdef _DEBUG
       
   465         iXcapProtocol.WriteToLog( _L8( "CXcapDirectory::CancelUpdate()" ) );
       
   466     #endif
       
   467     Cancel();
       
   468     }
       
   469     
       
   470 // ---------------------------------------------------------
       
   471 // CXcapDirectory::DoCancel
       
   472 // 
       
   473 // ---------------------------------------------------------
       
   474 //
       
   475 void CXcapDirectory::DoCancel()
       
   476     {
       
   477     #ifdef _DEBUG
       
   478         iXcapProtocol.WriteToLog( _L8( "CXcapDirectory::DoCancel()" ) );
       
   479     #endif
       
   480     switch( iUpdatePhase )
       
   481         {
       
   482         case EDirPhaseIdle:
       
   483             break;
       
   484         case EUpdateDocumentList:
       
   485             {
       
   486             CXcapDocument* doc = ( CXcapDocument* )iDirectoryDoc;
       
   487             doc->CancelUpdate();
       
   488             }
       
   489             break;
       
   490         case ERefreshDocuments:
       
   491             iHttpRetrieval->CancelRequest();
       
   492             break;
       
   493         default:
       
   494             break;
       
   495         }
       
   496     User::RequestComplete( iClientStatus, KErrCancel );
       
   497     }
       
   498 
       
   499 
       
   500 
       
   501