os/ossrv/genericservices/httputils/UriParser/GenericUriParser.cpp
author sl@SLION-WIN7.fritz.box
Fri, 15 Jun 2012 03:10:57 +0200
changeset 0 bde4ae8d615e
permissions -rw-r--r--
First public contribution.
sl@0
     1
// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     2
// All rights reserved.
sl@0
     3
// This component and the accompanying materials are made available
sl@0
     4
// under the terms of "Eclipse Public License v1.0"
sl@0
     5
// which accompanies this distribution, and is available
sl@0
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     7
//
sl@0
     8
// Initial Contributors:
sl@0
     9
// Nokia Corporation - initial contribution.
sl@0
    10
//
sl@0
    11
// Contributors:
sl@0
    12
//
sl@0
    13
// Description:
sl@0
    14
//
sl@0
    15
sl@0
    16
#include "GenericUriParser.h"
sl@0
    17
sl@0
    18
sl@0
    19
/** 
sl@0
    20
 * CGenericUriParser Constructor.
sl@0
    21
 */ 
sl@0
    22
CGenericUriParser::CGenericUriParser()
sl@0
    23
: CBase()
sl@0
    24
	{
sl@0
    25
	}
sl@0
    26
sl@0
    27
/** 
sl@0
    28
 * CGenericUriParser Static Factory Construction.
sl@0
    29
 */
sl@0
    30
CGenericUriParser* CGenericUriParser::NewL()
sl@0
    31
	{
sl@0
    32
	CGenericUriParser* self = new (ELeave) CGenericUriParser;
sl@0
    33
	CleanupStack::PushL(self);
sl@0
    34
	self->ConstructL();
sl@0
    35
	CleanupStack::Pop(self);
sl@0
    36
	return self;
sl@0
    37
	}
sl@0
    38
sl@0
    39
/**	
sl@0
    40
	Second phase of two-phase construction method. 
sl@0
    41
	
sl@0
    42
	@pre 			First phase of construction is complete.
sl@0
    43
	@post			The object is fully constructed and initialized.
sl@0
    44
 */
sl@0
    45
void CGenericUriParser::ConstructL()
sl@0
    46
	{
sl@0
    47
	// Does nothing.
sl@0
    48
	}
sl@0
    49
sl@0
    50
/**
sl@0
    51
 * Default Destructor.
sl@0
    52
 */
sl@0
    53
CGenericUriParser::~CGenericUriParser()
sl@0
    54
	{
sl@0
    55
	}
sl@0
    56
sl@0
    57
/**
sl@0
    58
	Function to parse a descriptor for a scheme component. If a scheme is found 
sl@0
    59
	then the output argument aScheme is set to refer to it.
sl@0
    60
						
sl@0
    61
	@param			aUri	The descriptor containing the uri to be parsed for 
sl@0
    62
	a scheme.
sl@0
    63
	@param			aScheme	The output descriptor to refer to the scheme
sl@0
    64
	@return			The number of characters consumed in parsing the scheme.
sl@0
    65
	@pre 			The output descriptor has been initialized so that the pointer
sl@0
    66
					to the associated descriptor buffer is NULL. The input descriptor 
sl@0
    67
					is set to the start of the uri.
sl@0
    68
	@post			If a scheme component exists then the output descriptor refers
sl@0
    69
					to it, otherwise the output descriptor is left unchanged.
sl@0
    70
*/
sl@0
    71
TInt CGenericUriParser::ParseScheme(const TPtrC8& aUri, TPtrC8& aScheme)
sl@0
    72
	{
sl@0
    73
	// Get the descriptor and look for scheme delimiter
sl@0
    74
	TInt consumed =0;
sl@0
    75
	TInt endSchemePos = FindFirstUriDelimiter(aUri, ESchemeDelimiterSearch);
sl@0
    76
sl@0
    77
	if( endSchemePos != KErrNotFound )
sl@0
    78
		{
sl@0
    79
		// Got a scheme - store information
sl@0
    80
		aScheme.Set(aUri.Left(endSchemePos));
sl@0
    81
sl@0
    82
		// Set consumed amount move past scheme delimiter
sl@0
    83
		consumed = endSchemePos + 1;
sl@0
    84
		}
sl@0
    85
	return consumed;
sl@0
    86
	}
sl@0
    87
	
sl@0
    88
/**
sl@0
    89
	Function to parse a descriptor for an authority component. If an authority is 
sl@0
    90
	found then the output arguments aUserinfo, aHost and aPort are set to refer to those parts 
sl@0
    91
	of the authority component. If an authority component exists then the host part exists. The 
sl@0
    92
	userinfo and port parts are optional.
sl@0
    93
						
sl@0
    94
	@param			aUri		The descriptor containing the uri to be parsed 
sl@0
    95
					for an authority.
sl@0
    96
	@param			aUserinfo	The output descriptor for the userinfo component.
sl@0
    97
	@param			aHost		The output descriptor for the host component.
sl@0
    98
	@param			aPort		The output descriptor for the port component.
sl@0
    99
	@param			aUseNetworkDelimiter Whether the scheme uses the network delimeter '//'
sl@0
   100
	@return			The number of characters consumed in parsing the authority.
sl@0
   101
	@pre 			The output descriptors have been initialized so that the pointer
sl@0
   102
					to the their associated descriptor buffers is NULL. The input descriptor 
sl@0
   103
					is set to the start of the start of the authority component.
sl@0
   104
	
sl@0
   105
	@post			If an authority component exists then the output descriptors refer
sl@0
   106
					to the userinfo part (if exists), the host part and the port part (if exists), 
sl@0
   107
					otherwise the output descriptors are left unchanged.
sl@0
   108
*/
sl@0
   109
TInt CGenericUriParser::ParseAuthority(const TPtrC8& aUri, TPtrC8& aUserinfo, TPtrC8& aHost, TPtrC8& aPort, TBool aUseNetworkDelimiter)
sl@0
   110
	{
sl@0
   111
	// Get uri descriptor and see if authority exists - if aUseNetworkDelimiter is true it has to start with '//' 
sl@0
   112
	TInt consumed =0;
sl@0
   113
	const TInt prefixLength = aUseNetworkDelimiter ? KUriNetworkAuthorityDelimiterLength : 0;
sl@0
   114
  	if( !aUseNetworkDelimiter || 
sl@0
   115
  		(aUri.Length() >= prefixLength && aUri[0] == KSlashDelimiter && aUri[1] == KSlashDelimiter ))
sl@0
   116
		{
sl@0
   117
		// There is an authority
sl@0
   118
		TPtrC8 authority( aUri.Mid(prefixLength) );
sl@0
   119
sl@0
   120
		// Authority delimited by '/', '?', '#' or the end of the string
sl@0
   121
		TInt authorityEndPos = FindFirstUriDelimiter(authority, EAuthDelimiterSearch);
sl@0
   122
sl@0
   123
		// Got authority - parse it for its components
sl@0
   124
		authority.Set(authority.Left(authorityEndPos));
sl@0
   125
sl@0
   126
		// Get the userinfo...
sl@0
   127
		TInt userinfoEndPos = authority.Locate(KUserinfoDelimiter);
sl@0
   128
		if( userinfoEndPos != KErrNotFound )
sl@0
   129
			{
sl@0
   130
			// Store the information 
sl@0
   131
			aUserinfo.Set(authority.Left(userinfoEndPos));
sl@0
   132
			  
sl@0
   133
			// Move past the userinfo and the delimiter '@'
sl@0
   134
			authority.Set(authority.Mid(userinfoEndPos + 1));
sl@0
   135
			}
sl@0
   136
sl@0
   137
		// Authority is also delimited by ';' but this is valid in the userinfo so can only be checked now
sl@0
   138
		TInt semicolonPos = FindFirstUriDelimiter(authority, ESemiColonDelimiterFlag);
sl@0
   139
		if ( semicolonPos != KErrNotFound )
sl@0
   140
			{
sl@0
   141
			authority.Set(authority.Left(semicolonPos));
sl@0
   142
			authorityEndPos = semicolonPos + userinfoEndPos + 1;
sl@0
   143
			}
sl@0
   144
		
sl@0
   145
		// Set consumed amount to move past authority
sl@0
   146
		consumed += prefixLength + authorityEndPos;
sl@0
   147
		
sl@0
   148
		// Check if this is an IPv6 address	by looking for the opening '['
sl@0
   149
		TInt startHostIPv6 = authority.Locate(KIPv6UriOpenBrace);
sl@0
   150
sl@0
   151
		if (startHostIPv6 == KErrNotFound)
sl@0
   152
			{
sl@0
   153
			// This isn't an IPv6 address.....
sl@0
   154
sl@0
   155
			// Get host...
sl@0
   156
			TInt hostEndPos = authority.Locate(KPortDelimiter);
sl@0
   157
sl@0
   158
			// Host also delimited by the end of the authority
sl@0
   159
			if( hostEndPos == KErrNotFound )
sl@0
   160
				{
sl@0
   161
				hostEndPos = authority.Length();	
sl@0
   162
				}
sl@0
   163
sl@0
   164
			// There's always a host, but can be empty - store information
sl@0
   165
			aHost.Set(authority.Left(hostEndPos));
sl@0
   166
sl@0
   167
			// Move past the host
sl@0
   168
			authority.Set(authority.Mid(hostEndPos));
sl@0
   169
			}
sl@0
   170
		else
sl@0
   171
			{
sl@0
   172
		
sl@0
   173
	    // First, move past the opening brace
sl@0
   174
	            authority.Set(authority.Mid(startHostIPv6 + 1));
sl@0
   175
	            // auth now = X:X:X]?????
sl@0
   176
sl@0
   177
			// This is an IPv6 address, so it MUST have the closing brace too....
sl@0
   178
			TInt endIPv6Host = authority.Locate(KIPv6UriCloseBrace);
sl@0
   179
sl@0
   180
			// Return an error if the closing IPv6 delimiter isn't there.
sl@0
   181
			// or Host is empty
sl@0
   182
			if (endIPv6Host == KErrNotFound || endIPv6Host == startHostIPv6 + 1)
sl@0
   183
				{
sl@0
   184
				return KUriUtilsErrInvalidUri;	
sl@0
   185
				}
sl@0
   186
sl@0
   187
			// It's an ipv6  address, with an opening and closing brace. So now just extract it
sl@0
   188
			// auth = [X:X:X]?????
sl@0
   189
sl@0
   190
sl@0
   191
			// Set the host, and need to remove the closing brace
sl@0
   192
			aHost.Set(authority.Left(endIPv6Host));
sl@0
   193
			// host = X:X:X
sl@0
   194
sl@0
   195
			// Move past the host
sl@0
   196
			authority.Set(authority.Mid(endIPv6Host + 1));
sl@0
   197
			}
sl@0
   198
		
sl@0
   199
		// Get the port...
sl@0
   200
		TInt portEndPos = authority.Length();
sl@0
   201
		if( portEndPos )
sl@0
   202
			{
sl@0
   203
			// Store the port - remove leading ':'
sl@0
   204
			aPort.Set(authority.Mid(1, portEndPos - 1));
sl@0
   205
			}
sl@0
   206
		}
sl@0
   207
	return consumed;
sl@0
   208
	}
sl@0
   209
	
sl@0
   210
/**
sl@0
   211
	Function to parse a descriptor for a path/parameter component.There is always a path component.
sl@0
   212
	The ouput argument aPath is set to the path/parameter component found.
sl@0
   213
						
sl@0
   214
	@param			aUri	The descriptor containing the uri to be parsed for a path.
sl@0
   215
	@param			aComponent	The output descriptor to refer to the path.
sl@0
   216
	@return			The number of characters consumed in parsing the path.
sl@0
   217
	@pre 			The output descriptor has been initialized so that the pointer
sl@0
   218
					to the associated descriptor buffer is NULL. The input descriptor 
sl@0
   219
					is set to the start of the path.
sl@0
   220
					
sl@0
   221
	@post			The output descriptor refers to the path component.
sl@0
   222
*/	
sl@0
   223
TInt CGenericUriParser::ParsePath(const TPtrC8& aUri, TPtrC8& aComponent)
sl@0
   224
	{
sl@0
   225
	// Get descriptor with the path
sl@0
   226
	TInt consumed =0;
sl@0
   227
sl@0
   228
	// Path is delimited by '?'. '#' or the end of the string
sl@0
   229
	TInt pathEndPos = FindFirstUriDelimiter(aUri, EPathDelimiterSearch);
sl@0
   230
sl@0
   231
	// Check for presence of path
sl@0
   232
	if( pathEndPos != KErrNotFound )
sl@0
   233
		{
sl@0
   234
		// Got path - store information
sl@0
   235
		aComponent.Set(aUri.Left(pathEndPos));
sl@0
   236
	
sl@0
   237
		// Set consumed amount to move past path
sl@0
   238
		consumed = pathEndPos;
sl@0
   239
		}
sl@0
   240
	return consumed;
sl@0
   241
	}
sl@0
   242
sl@0
   243
/**
sl@0
   244
	Function to parse a descriptor for a query/header component.If a query is found then 
sl@0
   245
	the output argument aQuery is set to refer to it.
sl@0
   246
						
sl@0
   247
	@param			aUri	The descriptor containing the uri to be parsed for 
sl@0
   248
					a query.
sl@0
   249
	@param			aComponent	The output descriptor to refer to the query
sl@0
   250
	@return			The number of characters consumed in parsing the query.
sl@0
   251
	@pre 			The output descriptor has been initialized so that the pointer
sl@0
   252
					to the associated descriptor buffer is NULL. The input descriptor is set to
sl@0
   253
					the start of the query.
sl@0
   254
	@post			If a query component exists then the output descriptor refers
sl@0
   255
					to it, otherwise the output descriptor is left unchanged.
sl@0
   256
*/
sl@0
   257
TInt CGenericUriParser::ParseQuery(const TPtrC8& aUri, TPtrC8& aComponent)
sl@0
   258
	{
sl@0
   259
	// Get descriptor with the query
sl@0
   260
	TInt consumed =0;
sl@0
   261
sl@0
   262
	// Query is delimited by '#' or end of the string 
sl@0
   263
	TInt queryEndPos = FindFirstUriDelimiter(aUri, EQueryDelimiterSearch);
sl@0
   264
sl@0
   265
	// Check for presence of query
sl@0
   266
	if( queryEndPos )
sl@0
   267
		{
sl@0
   268
		// Got query - store information; need to excluded leading '?'
sl@0
   269
		aComponent.Set(aUri.Mid(1, queryEndPos - 1));
sl@0
   270
	
sl@0
   271
		// Set consumed amount to move past query
sl@0
   272
		consumed = queryEndPos;
sl@0
   273
		}
sl@0
   274
	return consumed;
sl@0
   275
	}
sl@0
   276
	
sl@0
   277
/**
sl@0
   278
	Function to parse a descriptor for a fragment component. If a fragment is found then 
sl@0
   279
	the output argument aFragment is set to refer to it.
sl@0
   280
						
sl@0
   281
	@param			aUri	The descriptor containing the uri to be parsed for a fragment.
sl@0
   282
	@param			aComponent	The output descriptor to refer to the fragment.
sl@0
   283
	@return			The number of characters consumed in parsing the fragment.
sl@0
   284
	@pre 			The output descriptor has been initialized so that the pointer
sl@0
   285
					to the associated descriptor buffer is NULL. The input descriptor is set to
sl@0
   286
					the start of the fragment.
sl@0
   287
	@post			If a fragment component exists then the output descriptor refers
sl@0
   288
					to it, otherwise the output descriptor is left unchanged.
sl@0
   289
*/
sl@0
   290
TInt CGenericUriParser::ParseFragment(const TPtrC8& aUri, TPtrC8& aComponent)
sl@0
   291
	{
sl@0
   292
	// Get descriptor with the fragment
sl@0
   293
	TInt consumed =0;
sl@0
   294
sl@0
   295
	// Fragment is delimited by end of the string
sl@0
   296
	TInt fragmentEndPos = aUri.Length();
sl@0
   297
sl@0
   298
	// Check for presence of fragment
sl@0
   299
	if( fragmentEndPos )
sl@0
   300
		{
sl@0
   301
		// Got fragment - store information; need to excluded leading '#'
sl@0
   302
		aComponent.Set(aUri.Mid(1, fragmentEndPos - 1));
sl@0
   303
	
sl@0
   304
		// Set consumed amount to move past fragment
sl@0
   305
		consumed = fragmentEndPos;
sl@0
   306
		}
sl@0
   307
	return consumed;
sl@0
   308
	}
sl@0
   309
	
sl@0
   310
/**
sl@0
   311
	Function to find the position of the first delimiter in the descriptor specified 
sl@0
   312
	by the delimiter flags. Note that the end of the descriptor is also a delimiter if there are 
sl@0
   313
	no others. In the case of the scheme delimiter search, the position returned depends on the 
sl@0
   314
	position of the colon delimiter with respect to the other delimiters for a scheme.
sl@0
   315
						
sl@0
   316
	@param			aUri The descriptor containing the section of a uri to be searched.
sl@0
   317
	@param			aSearchFlag	The enum specifying the delimiters to search for.
sl@0
   318
	@return			The position of nearest delimiter to start of the descriptor, where
sl@0
   319
					zero is the start (left-most) position.
sl@0
   320
*/
sl@0
   321
TInt CGenericUriParser::FindFirstUriDelimiter(const TPtrC8& aUri, TDelimiterSearchFlag aSearchFlag)
sl@0
   322
	{
sl@0
   323
	// Set ultimate delimiter - string length
sl@0
   324
	TInt endPos = aUri.Length();
sl@0
   325
	if( aSearchFlag & EHashDelimiterFlag )
sl@0
   326
		{
sl@0
   327
		TInt fragmentPos = aUri.Locate(KFragmentDelimiter);
sl@0
   328
		if( fragmentPos != KErrNotFound && fragmentPos < endPos )
sl@0
   329
			{
sl@0
   330
			endPos = fragmentPos;	
sl@0
   331
			}
sl@0
   332
		}
sl@0
   333
	if( aSearchFlag & EQueryDelimiterFlag )
sl@0
   334
		{
sl@0
   335
		TInt queryPos = aUri.Locate(KQueryDelimiter);
sl@0
   336
		if( queryPos != KErrNotFound && queryPos < endPos )
sl@0
   337
			{
sl@0
   338
			endPos = queryPos;				
sl@0
   339
			}
sl@0
   340
		}
sl@0
   341
	if( aSearchFlag & ESlashDelimiterFlag )
sl@0
   342
		{
sl@0
   343
		TInt slashPos = aUri.Locate(KSlashDelimiter);
sl@0
   344
		if( slashPos != KErrNotFound && slashPos < endPos )
sl@0
   345
			{
sl@0
   346
			endPos = slashPos;	
sl@0
   347
			}
sl@0
   348
		}
sl@0
   349
	if( aSearchFlag & ESemiColonDelimiterFlag )
sl@0
   350
		{
sl@0
   351
		TInt semiColonPos = aUri.Locate(KParamDelimiter);
sl@0
   352
		if( semiColonPos != KErrNotFound && semiColonPos < endPos )
sl@0
   353
			{
sl@0
   354
			endPos = semiColonPos;	
sl@0
   355
			}
sl@0
   356
		}
sl@0
   357
	if( aSearchFlag & EColonDelimiterFlag )
sl@0
   358
		{
sl@0
   359
		TInt schemePos = aUri.Locate(KSchemeDelimiter);
sl@0
   360
		if( schemePos != KErrNotFound && schemePos < endPos )
sl@0
   361
			{
sl@0
   362
			// There is a scheme
sl@0
   363
			endPos = schemePos;
sl@0
   364
			}
sl@0
   365
		else if( aSearchFlag == ESchemeDelimiterSearch )
sl@0
   366
			{
sl@0
   367
			// Ok different if looking for scheme delimiter - no scheme, return KErrNotFound
sl@0
   368
			endPos = KErrNotFound;
sl@0
   369
			}
sl@0
   370
		}
sl@0
   371
	return endPos;
sl@0
   372
	}
sl@0
   373
sl@0
   374
sl@0
   375
sl@0
   376
sl@0
   377