realtimenetprots/sipfw/SIP/Codec/src/CSIPParamContainerBase.cpp
changeset 0 307788aac0a8
equal deleted inserted replaced
-1:000000000000 0:307788aac0a8
       
     1 // Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 // Name          : CSIPParamContainerBase.cpp
       
    15 // Part of       : SIP Codec
       
    16 // Version       : SIP/4.0 
       
    17 //
       
    18 
       
    19 
       
    20 
       
    21 
       
    22 #include "CSIPParamContainerBase.h"
       
    23 #include "CSIPTokenizer.h"
       
    24 #include "sipcodecerr.h"
       
    25 #include "sipstrings.h"
       
    26 #include "SIPSyntaxCheck.h"
       
    27 #include "sipcodecutils.h"
       
    28 #include "sipstrconsts.h"
       
    29 
       
    30 const TInt KMaxNumericValueAsTextLength = 80;
       
    31 _LIT8(KTIntFormat, "%d");
       
    32 
       
    33 // -----------------------------------------------------------------------------
       
    34 // CSIPParamContainerBase::CSIPParamContainerBase
       
    35 // -----------------------------------------------------------------------------
       
    36 //
       
    37 CSIPParamContainerBase::CSIPParamContainerBase(const TChar& aSeparator)
       
    38  : iParamSeparator (aSeparator)
       
    39 	{
       
    40 	}
       
    41 
       
    42 // -----------------------------------------------------------------------------
       
    43 // CSIPParamContainerBase::ConstructL
       
    44 // -----------------------------------------------------------------------------
       
    45 //
       
    46 void 
       
    47 CSIPParamContainerBase::ConstructL(const CSIPParamContainerBase& aContainer)
       
    48 	{
       
    49 	for (TInt i=0; i < aContainer.iParams.Count(); i++)
       
    50 		{
       
    51 		CSIPParam* param = CSIPParam::NewLC(*aContainer.iParams[i]);
       
    52 		User::LeaveIfError(iParams.Append(param));
       
    53 		CleanupStack::Pop(param);
       
    54 		}
       
    55 	}
       
    56 
       
    57 // -----------------------------------------------------------------------------
       
    58 // CSIPParamContainerBase::~CSIPParamContainerBase
       
    59 // -----------------------------------------------------------------------------
       
    60 //
       
    61 CSIPParamContainerBase::~CSIPParamContainerBase()
       
    62 	{
       
    63 	iParams.ResetAndDestroy();
       
    64 	}
       
    65 
       
    66 // -----------------------------------------------------------------------------
       
    67 // CSIPParamContainerBase::SetParamL
       
    68 // -----------------------------------------------------------------------------
       
    69 //
       
    70 void CSIPParamContainerBase::SetParamL(RStringF aName)
       
    71 	{
       
    72 	CSIPParam* param = CSIPParam::NewLC(aName);
       
    73 	SetParamL(param);
       
    74 	CleanupStack::Pop(param);
       
    75 	}
       
    76 
       
    77 // -----------------------------------------------------------------------------
       
    78 // CSIPParamContainerBase::SetParamL
       
    79 // -----------------------------------------------------------------------------
       
    80 //
       
    81 void CSIPParamContainerBase::SetParamL(RStringF aName, RStringF aValue)
       
    82 	{
       
    83 	CSIPParam* param = CSIPParam::NewLC(aName,aValue);
       
    84 	SetParamL(param);
       
    85 	CleanupStack::Pop(param);
       
    86 	}
       
    87 
       
    88 // -----------------------------------------------------------------------------
       
    89 // CSIPParamContainerBase::SetParamL
       
    90 // -----------------------------------------------------------------------------
       
    91 //
       
    92 void CSIPParamContainerBase::SetParamL(RStringF aName, const TDesC8& aValue)
       
    93 	{
       
    94 	CSIPParam* param = CSIPParam::NewLC(aName,aValue);
       
    95 	SetParamL(param);
       
    96 	CleanupStack::Pop(param);
       
    97 	}
       
    98 
       
    99 // -----------------------------------------------------------------------------
       
   100 // CSIPParamContainerBase::SetDesParamL
       
   101 // -----------------------------------------------------------------------------
       
   102 //
       
   103 void CSIPParamContainerBase::SetDesParamL(RStringF aName, const TDesC8& aValue)
       
   104     {
       
   105     CSIPParam* param = CSIPParam::NewLC(aName,aValue);
       
   106     SetParamL(param);
       
   107     CleanupStack::Pop(param);
       
   108     param->SetValueL(aValue,ETrue);
       
   109     }
       
   110 
       
   111 // -----------------------------------------------------------------------------
       
   112 // CSIPParamContainerBase::SetParamL
       
   113 // -----------------------------------------------------------------------------
       
   114 //
       
   115 void CSIPParamContainerBase::SetParamL(RStringF aName, TInt aValue)
       
   116 	{
       
   117 	__ASSERT_ALWAYS(aValue >= 0, User::Leave(KErrSipCodecAnyParam));
       
   118 	TBuf8<KMaxNumericValueAsTextLength> valueAsText;
       
   119 	valueAsText.Format(KTIntFormat,aValue);
       
   120 	SetParamL(aName,valueAsText);
       
   121 	}
       
   122 
       
   123 // -----------------------------------------------------------------------------
       
   124 // CSIPParamContainerBase::SetParamL
       
   125 // -----------------------------------------------------------------------------
       
   126 //
       
   127 void CSIPParamContainerBase::SetParamL(RStringF aName, TReal aValue)
       
   128 	{
       
   129 	TBuf8<KMaxNumericValueAsTextLength> valueAsText;
       
   130 	TRealFormat format;
       
   131 	const TChar KDotChr = '.';
       
   132 	format.iPoint = KDotChr; // SIP uses always dot as a decimal point
       
   133 	User::LeaveIfError(valueAsText.Num(aValue,format));
       
   134 	SetParamL(aName, valueAsText);
       
   135 	}	
       
   136 
       
   137 // -----------------------------------------------------------------------------
       
   138 // CSIPParamContainerBase::SetParamL
       
   139 // -----------------------------------------------------------------------------
       
   140 //
       
   141 void CSIPParamContainerBase::SetParamL (CSIPParam* aParam)
       
   142 	{
       
   143 	__ASSERT_ALWAYS (aParam != NULL, User::Leave(KErrSipCodecAnyParam));
       
   144 	
       
   145 	CheckParamL(*aParam);
       
   146 
       
   147 	TInt index = FindParamIndex (aParam->Name());
       
   148 	User::LeaveIfError (iParams.Append(aParam));
       
   149 	if (index >= 0) // remove the old param
       
   150 		{
       
   151 		CSIPParam* oldParam = iParams[index];
       
   152 		iParams.Remove(index);
       
   153 		delete oldParam;
       
   154 		}	
       
   155 	}
       
   156 
       
   157 // -----------------------------------------------------------------------------
       
   158 // CSIPParamContainerBase::HasParam
       
   159 // -----------------------------------------------------------------------------
       
   160 //
       
   161 TBool CSIPParamContainerBase::HasParam (RStringF aParamName) const
       
   162 	{
       
   163 	return (FindParamIndex(aParamName) >= 0);
       
   164 	}
       
   165 
       
   166 // -----------------------------------------------------------------------------
       
   167 // CSIPParamContainerBase::ParamValue
       
   168 // -----------------------------------------------------------------------------
       
   169 //
       
   170 RStringF CSIPParamContainerBase::ParamValue (RStringF aParamName) const
       
   171 	{
       
   172 	TInt index = FindParamIndex(aParamName);
       
   173 	if (index >= 0 && iParams[index]->HasValue())
       
   174 		{
       
   175 		return iParams[index]->Value();
       
   176 		}
       
   177 	return SIPStrings::StringF(SipStrConsts::EEmpty);
       
   178 	}
       
   179 
       
   180 // -----------------------------------------------------------------------------
       
   181 // CSIPParamContainerBase::DesParamValue
       
   182 // -----------------------------------------------------------------------------
       
   183 //	
       
   184 const TDesC8& CSIPParamContainerBase::DesParamValue(RStringF aParamName) const
       
   185     {
       
   186 	TInt index = FindParamIndex(aParamName);
       
   187 	if (index >= 0)
       
   188 		{
       
   189 		return iParams[index]->DesValue();
       
   190 		}
       
   191 	return KNullDesC8;    
       
   192     }	
       
   193 
       
   194 // -----------------------------------------------------------------------------
       
   195 // CSIPParamContainerBase::IntParamValue
       
   196 // -----------------------------------------------------------------------------
       
   197 //
       
   198 TInt CSIPParamContainerBase::IntParamValue (RStringF aParamName) const
       
   199 	{
       
   200 	TPtrC8 des(ParamValue(aParamName).DesC());
       
   201 	TInt value=KErrNotFound;
       
   202 	if (des.Length() > 0)
       
   203 		{
       
   204 		TLex8 lex(des);
       
   205 		TInt err = lex.Val(value);
       
   206 		if (value < 0)
       
   207 			{
       
   208 			value = KErrSipCodecAnyParamValue;
       
   209 			}	
       
   210 		if (err != KErrNone)
       
   211 			{
       
   212 			value = err;
       
   213 			}
       
   214 		}
       
   215 	return value;
       
   216 	}
       
   217 
       
   218 // -----------------------------------------------------------------------------
       
   219 // CSIPParamContainerBase::RealParamValue
       
   220 // -----------------------------------------------------------------------------
       
   221 //
       
   222 TReal CSIPParamContainerBase::RealParamValue (RStringF aParamName) const
       
   223 	{
       
   224 	TLex8 lex(ParamValue(aParamName).DesC());
       
   225 	TReal value = 0;
       
   226 	const TChar KDotChr = '.';
       
   227 	lex.Val(value,KDotChr); // SIP uses always dot as a decimal point
       
   228 	return value;
       
   229 	}
       
   230 
       
   231 // -----------------------------------------------------------------------------
       
   232 // CSIPParamContainerBase::DeleteParam
       
   233 // -----------------------------------------------------------------------------
       
   234 //
       
   235 void CSIPParamContainerBase::DeleteParam (RStringF aParamName)
       
   236 	{
       
   237 	TInt index = FindParamIndex (aParamName);
       
   238 	if (index >= 0) 
       
   239 		{
       
   240 		CSIPParam* param = iParams[index];
       
   241 		iParams.Remove(index);
       
   242 		delete param;
       
   243 		}
       
   244 	}
       
   245 
       
   246 // -----------------------------------------------------------------------------
       
   247 // CSIPParamContainerBase::ParamCount
       
   248 // -----------------------------------------------------------------------------
       
   249 //
       
   250 TInt CSIPParamContainerBase::ParamCount() const
       
   251 	{
       
   252 	return iParams.Count();
       
   253 	}
       
   254 
       
   255 // -----------------------------------------------------------------------------
       
   256 // CSIPParamContainerBase::ParamName
       
   257 // -----------------------------------------------------------------------------
       
   258 //	
       
   259 TInt CSIPParamContainerBase::ParamName(TInt aIndex, RStringF& aParamName) const
       
   260     {
       
   261     TInt err = KErrNotFound;
       
   262     if (aIndex >= 0 && aIndex < iParams.Count())
       
   263         {
       
   264         aParamName = iParams[aIndex]->Name().Copy();
       
   265         err = KErrNone;
       
   266         }
       
   267     return err;
       
   268     }
       
   269 
       
   270 // -----------------------------------------------------------------------------
       
   271 // CSIPParamContainerBase::ToTextLC
       
   272 // -----------------------------------------------------------------------------
       
   273 //
       
   274 HBufC8* CSIPParamContainerBase::ToTextLC () const
       
   275 	{
       
   276 	TUint encodedLength = 0;
       
   277 
       
   278 	RPointerArray<HBufC8> paramsAsText;
       
   279 	CleanupStack::PushL (TCleanupItem(ResetAndDestroy,&paramsAsText));
       
   280 
       
   281 	for (TInt i=0; i < iParams.Count(); i++)
       
   282 		{
       
   283 		HBufC8* paramAsText = iParams[i]->ToTextLC();
       
   284 		encodedLength += paramAsText->Length();
       
   285 		if (i < iParams.Count()-1) 
       
   286 		    {
       
   287 		    encodedLength += 1; // param separator
       
   288 		    }
       
   289 		paramsAsText.AppendL(paramAsText);
       
   290 		CleanupStack::Pop(paramAsText);
       
   291 		}
       
   292 	
       
   293 	HBufC8* encodedParams = HBufC8::NewL (encodedLength);
       
   294 	TPtr8 encodedParamsPtr = encodedParams->Des();
       
   295 
       
   296 	for (TInt j=0; j < paramsAsText.Count(); j++)
       
   297 		{
       
   298 		encodedParamsPtr.Append (*paramsAsText[j]);
       
   299 		if (j < paramsAsText.Count()-1)
       
   300 			{
       
   301 			encodedParamsPtr.Append(iParamSeparator);
       
   302 			}
       
   303 		}
       
   304 
       
   305 	CleanupStack::PopAndDestroy(1); // paramsAsText
       
   306 	CleanupStack::PushL(encodedParams);
       
   307 	return encodedParams;
       
   308 	}
       
   309 
       
   310 // -----------------------------------------------------------------------------
       
   311 // CSIPParamContainerBase::ExternalizeL
       
   312 // -----------------------------------------------------------------------------
       
   313 //
       
   314 void CSIPParamContainerBase::ExternalizeL (RWriteStream& aWriteStream)
       
   315 	{
       
   316 	aWriteStream.WriteUint32L (iParams.Count());
       
   317 	for (TInt i=0; i < iParams.Count(); i++)
       
   318 		{
       
   319 		iParams[i]->ExternalizeL(aWriteStream);
       
   320 		}
       
   321 	}
       
   322 
       
   323 // -----------------------------------------------------------------------------
       
   324 // CSIPParamContainerBase::DoInternalizeL
       
   325 // -----------------------------------------------------------------------------
       
   326 //
       
   327 void CSIPParamContainerBase::DoInternalizeL (RReadStream& aReadStream)
       
   328 	{
       
   329 	TUint32 parameterCount = aReadStream.ReadUint32L();
       
   330 	for (TUint32 i=0; i < parameterCount; i++)
       
   331 		{
       
   332 		CSIPParam* param = CSIPParam::InternalizeL(aReadStream);
       
   333 		CleanupStack::PushL (param);
       
   334 		SetParamL(param);
       
   335 		CleanupStack::Pop(param);
       
   336 		}
       
   337 	}
       
   338 
       
   339 // -----------------------------------------------------------------------------
       
   340 // CSIPParamContainerBase::ParseL
       
   341 // -----------------------------------------------------------------------------
       
   342 //
       
   343 void CSIPParamContainerBase::ParseL (const TDesC8& aValue)
       
   344 	{
       
   345 	CSIPTokenizer* tokenizer = CSIPTokenizer::NewLC (aValue,iParamSeparator);
       
   346 	for (TInt i=0; i < tokenizer->Tokens().Count(); i++)
       
   347 		{
       
   348 		TPtrC8 pname;
       
   349 		TPtrC8 pvalue(KNullDesC8);
       
   350 		TBool hasValue = CSIPParam::ParseL(tokenizer->Tokens()[i],pname,pvalue);
       
   351 		CSIPParam* param = CSIPParam::NewLC(pname);
       
   352 		RStringF pnameStr = param->Name();
       
   353 		if (HasParam(pnameStr)) 
       
   354 			{
       
   355 			User::Leave(KErrSipCodecDuplicateParam);
       
   356 			}
       
   357 		CheckAndUpdateParamL(pnameStr,hasValue,pvalue);
       
   358 		if (hasValue)
       
   359 		    {
       
   360 		    param->SetValueL(pvalue,AddQuotesWhenEncoding(pnameStr));
       
   361 		    }
       
   362         User::LeaveIfError(iParams.Append(param));
       
   363 		CleanupStack::Pop(param);
       
   364 		}
       
   365 	CleanupStack::PopAndDestroy(tokenizer);
       
   366 	}
       
   367 
       
   368 // -----------------------------------------------------------------------------
       
   369 // CSIPParamContainerBase::FindParamIndex
       
   370 // -----------------------------------------------------------------------------
       
   371 //
       
   372 TInt CSIPParamContainerBase::FindParamIndex (RStringF aParamName) const
       
   373 	{
       
   374 	for (TInt i=0; i < iParams.Count(); i++)
       
   375 		{
       
   376 		if (aParamName == iParams[i]->Name()) 
       
   377 			{
       
   378 			return i;
       
   379 			}
       
   380 		}
       
   381 	return KErrNotFound;
       
   382 	}
       
   383 
       
   384 // -----------------------------------------------------------------------------
       
   385 // CSIPParamContainerBase::ResetAndDestroy
       
   386 // -----------------------------------------------------------------------------
       
   387 //
       
   388 void CSIPParamContainerBase::ResetAndDestroy (TAny* anArray)
       
   389 	{
       
   390 	(reinterpret_cast<RPointerArray<HBufC8>*> (anArray))->ResetAndDestroy();
       
   391 	}
       
   392 
       
   393 // -----------------------------------------------------------------------------
       
   394 // CSIPParamContainerBase::CheckGenericParamL
       
   395 // -----------------------------------------------------------------------------
       
   396 //
       
   397 void CSIPParamContainerBase::CheckGenericParamL(CSIPParam& aParam,
       
   398                                                 TInt aLeaveCode) const
       
   399     {
       
   400     TPtrC8 value(aParam.Value().DesC());
       
   401     CheckGenericParamL(aParam.Name(),aParam.HasValue(),value,aLeaveCode);
       
   402     } 
       
   403 
       
   404 // -----------------------------------------------------------------------------
       
   405 // CSIPParamContainerBase::CheckGenericParamL
       
   406 // -----------------------------------------------------------------------------
       
   407 //
       
   408 void CSIPParamContainerBase::CheckGenericParamL(RStringF aName,
       
   409 	                                            TBool aHasValue,
       
   410 	                                            const TDesC8& aValue, 
       
   411                                                 TInt aLeaveCode) const
       
   412     {
       
   413 	if (!SIPSyntaxCheck::Token(aName.DesC()))
       
   414 		{
       
   415 		User::Leave(aLeaveCode);
       
   416 		}
       
   417 	if (!aHasValue) 
       
   418 		{
       
   419 		return;
       
   420 		}
       
   421 	if (!SIPSyntaxCheck::GenericParamValue(aValue))
       
   422 		{
       
   423 		User::Leave(aLeaveCode);
       
   424 		}
       
   425     }
       
   426 
       
   427 // -----------------------------------------------------------------------------
       
   428 // CSIPParamContainerBase::RemoveQuotes
       
   429 // -----------------------------------------------------------------------------
       
   430 //  
       
   431 void CSIPParamContainerBase::RemoveQuotes(TPtrC8& aParamValue) const
       
   432     {
       
   433     if (SIPSyntaxCheck::StartsAndEndsWithQuotes(aParamValue))
       
   434         {
       
   435 		TPtrC8 valueWithoutQuotes;
       
   436         SIPCodecUtils::ValueWithoutQuotes(aParamValue, valueWithoutQuotes);
       
   437         aParamValue.Set(valueWithoutQuotes);
       
   438 		}   
       
   439     }
       
   440     
       
   441 // ----------------------------------------------------------------------------
       
   442 // CSIPParamContainerBase::AddQuotesWhenEncoding
       
   443 // ----------------------------------------------------------------------------
       
   444 //    
       
   445 TBool CSIPParamContainerBase::AddQuotesWhenEncoding(
       
   446     RStringF /*aParamName*/) const
       
   447     {
       
   448     return EFalse;
       
   449     }
       
   450     
       
   451 // ----------------------------------------------------------------------------
       
   452 // CSIPParamContainerBase::CheckParamL
       
   453 // ----------------------------------------------------------------------------
       
   454 //
       
   455 void CSIPParamContainerBase::CheckParamL(CSIPParam& aParam) const
       
   456 	{
       
   457 	RStringF name = aParam.Name();
       
   458 	TPtrC8 value = aParam.Value().DesC();
       
   459 	if (aParam.DesValue().Length() > 0)
       
   460 	    {
       
   461 	    value.Set(aParam.DesValue());
       
   462 	    }	
       
   463 	CheckAndUpdateParamL(name,aParam.HasValue(),value);
       
   464 	if (AddQuotesWhenEncoding(name))
       
   465 	    {
       
   466 	    // Quotes may have been removed. Set the updated value.
       
   467 	    aParam.SetValueL(value,ETrue);     
       
   468 	    }
       
   469 	}    
       
   470     
       
   471 // -----------------------------------------------------------------------------
       
   472 // CSIPParamContainerBase::CheckAndUpdateParamL
       
   473 // -----------------------------------------------------------------------------
       
   474 //      
       
   475 void CSIPParamContainerBase::CheckAndUpdateParamL(RStringF /*aName*/,
       
   476                                                   TBool /*aHasValue*/,
       
   477                                                   TPtrC8& /*aValue*/) const
       
   478     {
       
   479     // By default NOP.
       
   480     }