ncdengine/provider/protocol/src/ncdrequestbrowsesearch.cpp
changeset 0 ba25891c3a9e
equal deleted inserted replaced
-1:000000000000 0:ba25891c3a9e
       
     1 /*
       
     2 * Copyright (c) 2006 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:   CNcdRequestBrowseSearch implementation
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #include "ncdrequestbrowsesearch.h"
       
    20 #include "ncdrequestbase.h"
       
    21 #include "ncdrequestconfigurationdata.h"
       
    22 #include "catalogsdebug.h"
       
    23 #include "ncdprotocolutils.h"
       
    24 #include "ncdprotocoltypes.h"
       
    25 #include "ncdprotocolwords.h"
       
    26 
       
    27 CNcdRequestBrowseSearch* CNcdRequestBrowseSearch::NewL()
       
    28     {
       
    29     CNcdRequestBrowseSearch* self = 
       
    30         CNcdRequestBrowseSearch::NewLC( );
       
    31     CleanupStack::Pop();
       
    32     return self;
       
    33     }
       
    34 
       
    35 CNcdRequestBrowseSearch* CNcdRequestBrowseSearch::NewLC()
       
    36     {
       
    37     CNcdRequestBrowseSearch* self = 
       
    38         new (ELeave) CNcdRequestBrowseSearch();
       
    39     CleanupStack::PushL(self);
       
    40     self->ConstructL();
       
    41     return self;
       
    42     }
       
    43 
       
    44 void CNcdRequestBrowseSearch::ConstructL()
       
    45     {
       
    46     DLTRACEIN((""));
       
    47     CNcdRequestBase::ConstructL( KTagPreminetRequest );
       
    48     iName.SetL(KTagBrowse);
       
    49     iNamespaceUri.SetL(KDefaultNamespaceUri);
       
    50     iPrefix.SetL(KAttrCdpNamespacePrefix);
       
    51     iVersion.SetL(KAttrPreminetVersion);
       
    52     DLTRACEOUT((""));
       
    53     }
       
    54     
       
    55 CNcdRequestBrowseSearch::CNcdRequestBrowseSearch()
       
    56 : CNcdRequestBase(), iDoSearch(EFalse)
       
    57     {
       
    58     }
       
    59 
       
    60 CNcdRequestBrowseSearch::~CNcdRequestBrowseSearch()
       
    61     {
       
    62     DLTRACEIN((""));
       
    63     if (iName.NotNull())
       
    64         iName.Free();
       
    65     if (iNamespaceUri.NotNull())
       
    66         iNamespaceUri.Free();
       
    67     if (iPrefix.NotNull())
       
    68         iPrefix.Free();
       
    69     if (iType.NotNull())
       
    70         iType.Free();
       
    71     
       
    72     ResetAndCloseArray( iEntities );
       
    73     
       
    74     iEntityFilter.Close();    
       
    75     
       
    76     iResponseFilter.Close();
       
    77         
       
    78     DLTRACEOUT((""));
       
    79     }
       
    80 
       
    81 
       
    82 void CNcdRequestBrowseSearch::SetSearch(TBool aDoSearch) 
       
    83     {
       
    84     iDoSearch = aDoSearch;
       
    85     }
       
    86 
       
    87 
       
    88 void CNcdRequestBrowseSearch::AddEntityL(
       
    89     const TDesC& aId, 
       
    90     TBool aIncludeMetadata) 
       
    91     {
       
    92     DLTRACEIN((_L("entry")));
       
    93     AddEntityL(aId, KNullDesC, aIncludeMetadata);
       
    94     }
       
    95     
       
    96 void CNcdRequestBrowseSearch::AddEntityL(
       
    97     const TDesC& aId, 
       
    98     const TDesC& aTimestamp, 
       
    99     TBool aIncludeMetadata) 
       
   100     {
       
   101     DLTRACEIN((_L("entry")));
       
   102     TNcdRequestRemoteEntity ent;
       
   103     ent.id.SetL(aId);
       
   104     
       
   105     if (aTimestamp != KNullDesC)
       
   106         ent.timeStamp.SetL(aTimestamp);
       
   107     
       
   108     ent.includeMetaData = 
       
   109         aIncludeMetadata ? EValueTrue : EValueFalse;
       
   110     iEntities.AppendL(ent);
       
   111     }
       
   112 
       
   113 void CNcdRequestBrowseSearch::AddEntityFilterL(
       
   114     const MDesC16Array& aIncludedKeywords,
       
   115     const MDesC16Array& aIncludedContentPurposes,    
       
   116     TBool         aSubscribableContent,
       
   117     TBool         aFreeContent) 
       
   118     {
       
   119     DLTRACEIN(("entry"));
       
   120     iEntityFilter.keywords.Reset();
       
   121     for (TInt i = 0; i < aIncludedKeywords.MdcaCount(); ++i) 
       
   122         {
       
   123         TPtrC16 ptr = aIncludedKeywords.MdcaPoint(i);
       
   124         if ( ptr.Length() > 0) 
       
   125             {
       
   126             TNcdRequestFilter keyword;
       
   127             keyword.text.SetL(ptr);
       
   128             keyword.exclude = EValueFalse;
       
   129             iEntityFilter.keywords.Append( keyword );
       
   130             }
       
   131         }
       
   132         
       
   133 
       
   134     DLTRACE((""));
       
   135     iEntityFilter.contentPurposes.Reset();
       
   136     for (TInt i = 0; i < aIncludedContentPurposes.MdcaCount(); ++i) 
       
   137         {
       
   138         TPtrC16 ptr = aIncludedContentPurposes.MdcaPoint(i);
       
   139         if ( ptr.Length() > 0) 
       
   140             {
       
   141             TNcdRequestFilter contentPurpose;
       
   142             contentPurpose.text.SetL(ptr);
       
   143             contentPurpose.exclude = EValueFalse;
       
   144             iEntityFilter.contentPurposes.Append( contentPurpose );
       
   145             }
       
   146         }
       
   147 
       
   148     DLTRACE((""));
       
   149 
       
   150     iEntityFilter.subscribableContent = 
       
   151         aSubscribableContent ? EValueTrue : EValueFalse;
       
   152     iEntityFilter.freeContent = 
       
   153         aFreeContent ? EValueTrue : EValueFalse;
       
   154     
       
   155     // Should add details
       
   156     iEntityFilterEnabled = ETrue;
       
   157     }
       
   158     
       
   159 
       
   160 void CNcdRequestBrowseSearch::AddResponseFilterL(
       
   161     TInt          aPageSize,
       
   162     TInt          aPageStart,
       
   163     TInt          aStructureDepth,
       
   164     TInt          aMetaDataDepth,
       
   165     TInt          aMetaDataPerLevel,
       
   166     const MDesC16Array& aIncludedElements,
       
   167     const MDesC16Array& aExcludedElements )
       
   168     {
       
   169     DLTRACEIN((_L("entry")));
       
   170     iResponseFilter.pageSize = aPageSize;
       
   171     iResponseFilter.pageStart = aPageStart;
       
   172     iResponseFilter.structureDepth = aStructureDepth;
       
   173     iResponseFilter.metadataDepth = aMetaDataDepth;
       
   174     iResponseFilter.metadataPerLevel = aMetaDataPerLevel;
       
   175     
       
   176     iResponseFilter.includedElements.Reset();
       
   177     for (TInt i = 0; i < aIncludedElements.MdcaCount(); ++i) 
       
   178         {
       
   179         TPtrC16 ptr = aIncludedElements.MdcaPoint(i);
       
   180         if ( ptr.Length() > 0) 
       
   181             {
       
   182             TXmlEngString element;
       
   183             element.SetL(ptr);
       
   184             iResponseFilter.includedElements.Append( element );
       
   185             }
       
   186         }
       
   187 
       
   188     iResponseFilter.excludedElements.Reset();
       
   189     for (TInt i = 0; i < aExcludedElements.MdcaCount(); ++i) 
       
   190         {
       
   191         TPtrC16 ptr = aExcludedElements.MdcaPoint(i);
       
   192         if ( ptr.Length() > 0) 
       
   193             {
       
   194             TXmlEngString element;
       
   195             element.SetL(ptr);
       
   196             iResponseFilter.excludedElements.Append( element );
       
   197             }
       
   198         }
       
   199         
       
   200     iResponseFilterEnabled = ETrue;
       
   201     }
       
   202 
       
   203 // generates the dom nodes
       
   204 HBufC8* CNcdRequestBrowseSearch::CreateRequestL()
       
   205     {
       
   206     DLTRACEIN((_L("entry")));
       
   207     if ( iDoSearch ) 
       
   208         iRequestElement = NcdProtocolUtils::NewElementL(iDocument, KTagSearch);
       
   209     else 
       
   210         iRequestElement = NcdProtocolUtils::NewElementL(iDocument, KTagBrowse);
       
   211         
       
   212     if (iConfiguration)
       
   213         iConfiguration->SetNamespacePrefixL( KAttrCdpNamespacePrefix );
       
   214 
       
   215     // entity
       
   216     for (TInt i = 0; i < iEntities.Count(); ++i)
       
   217         {
       
   218         // create remote entity elements
       
   219         TNcdRequestRemoteEntity entity = iEntities[i];
       
   220         TXmlEngElement entityElement = 
       
   221             NcdProtocolUtils::NewElementL( 
       
   222                 iDocument, iRequestElement, KTagEntity );
       
   223 
       
   224         NcdProtocolUtils::NewAttributeL( 
       
   225             entityElement, KAttrId, entity.id);
       
   226 
       
   227         if (entity.timeStamp.NotNull())
       
   228             NcdProtocolUtils::NewAttributeL( 
       
   229                 entityElement, KAttrTimeStamp, entity.timeStamp);
       
   230 
       
   231         if (entity.includeMetaData != EValueNotSet) 
       
   232             {
       
   233             NcdProtocolUtils::NewNcdBoolAttributeL( 
       
   234                 entityElement, KAttrIncludeMetaData, 
       
   235                 entity.includeMetaData);
       
   236             }
       
   237         }
       
   238     
       
   239     // responseFilter
       
   240     if (iResponseFilterEnabled)
       
   241         {
       
   242         // create element for response filter
       
   243         TXmlEngElement responseFilter = NcdProtocolUtils::NewElementL( 
       
   244             iDocument, iRequestElement, KTagResponseFilter );
       
   245         NcdProtocolUtils::NewAttributeL( 
       
   246             responseFilter, KAttrPageSize, iResponseFilter.pageSize );
       
   247         NcdProtocolUtils::NewAttributeL( 
       
   248             responseFilter, KAttrPageStart, iResponseFilter.pageStart );
       
   249         NcdProtocolUtils::NewAttributeL( 
       
   250             responseFilter, KAttrStructureDepth, 
       
   251             iResponseFilter.structureDepth );
       
   252         NcdProtocolUtils::NewAttributeL( 
       
   253             responseFilter, KAttrMetadataDepth, 
       
   254             iResponseFilter.metadataDepth );
       
   255         NcdProtocolUtils::NewAttributeL( 
       
   256             responseFilter, KAttrMetadataPerLevel, 
       
   257             iResponseFilter.metadataPerLevel );
       
   258 
       
   259         TBool inc = EFalse;
       
   260         for ( TInt i = 0; i < iResponseFilter.includedElements.Count(); ++i )
       
   261             {
       
   262             TXmlEngElement includeElement = NcdProtocolUtils::NewElementL( 
       
   263                 iDocument, responseFilter, KTagIncludeElement );
       
   264             NcdProtocolUtils::NewAttributeL( 
       
   265                 includeElement, KAttrName, iResponseFilter.includedElements[i] );
       
   266             inc = ETrue;
       
   267             }
       
   268         for ( TInt i = 0; !inc && i < iResponseFilter.excludedElements.Count(); ++i )
       
   269             {
       
   270             TXmlEngElement excludeElement = NcdProtocolUtils::NewElementL( 
       
   271                 iDocument, responseFilter, KTagExcludeElement );
       
   272             NcdProtocolUtils::NewAttributeL( 
       
   273                 excludeElement, KAttrName, iResponseFilter.excludedElements[i] );
       
   274             }
       
   275 
       
   276         }
       
   277 
       
   278     
       
   279     // entityFilter
       
   280     if (iEntityFilterEnabled) 
       
   281         {
       
   282         // create element for entity filter
       
   283         TXmlEngElement entityFilter = NcdProtocolUtils::NewElementL( 
       
   284                 iDocument, iRequestElement, KTagEntityFilter );
       
   285 
       
   286         NcdProtocolUtils::NewNcdBoolAttributeL( 
       
   287             entityFilter, KAttrSubscribableContent, 
       
   288             iEntityFilter.subscribableContent );
       
   289         NcdProtocolUtils::NewNcdBoolAttributeL( 
       
   290             entityFilter, KAttrFreeContent, iEntityFilter.freeContent );
       
   291 
       
   292         if ( iEntityFilter.keywords.Count() > 0 ) 
       
   293             {
       
   294             TXmlEngElement keywords = NcdProtocolUtils::NewElementL( 
       
   295                     iDocument, entityFilter, KTagKeywords );
       
   296             for ( TInt i = 0; i < iEntityFilter.keywords.Count(); ++i ) 
       
   297                 {
       
   298                 TNcdRequestFilter filter = iEntityFilter.keywords[i];
       
   299                 TXmlEngElement keyword = 
       
   300                     NcdProtocolUtils::NewElementL( 
       
   301                         iDocument, keywords, KTagKeyword );
       
   302                 keyword.SetTextL(filter.text.PtrC8());
       
   303                 NcdProtocolUtils::NewNcdBoolAttributeL( 
       
   304                     keyword, KAttrExclude, filter.exclude );
       
   305                 }
       
   306             }
       
   307                         
       
   308         if ( iEntityFilter.contentPurposes.Count() > 0 ) 
       
   309             {
       
   310             TXmlEngElement contentPurposes = NcdProtocolUtils::NewElementL( 
       
   311                     iDocument, entityFilter, KTagContentPurposes );
       
   312             for ( TInt i = 0; i < iEntityFilter.contentPurposes.Count(); ++i ) 
       
   313                 {
       
   314                 TNcdRequestFilter filter = iEntityFilter.contentPurposes[i];
       
   315                 TXmlEngElement contentPurpose = NcdProtocolUtils::NewElementL( 
       
   316                     iDocument, contentPurposes, KTagContentPurpose );
       
   317                 contentPurpose.SetTextL(filter.text.PtrC8());
       
   318                 NcdProtocolUtils::NewNcdBoolAttributeL( 
       
   319                     contentPurpose, KAttrExclude, filter.exclude );
       
   320                 }
       
   321             }
       
   322         }
       
   323 
       
   324     DLTRACEOUT((_L("exit")));
       
   325     
       
   326     // base class generates the complete request
       
   327     return CNcdRequestBase::CreateRequestL();
       
   328     }