diff -r 000000000000 -r e4d67989cc36 genericservices/httputils/UriParser/GenericUriParser.cpp --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/genericservices/httputils/UriParser/GenericUriParser.cpp Tue Feb 02 02:01:42 2010 +0200 @@ -0,0 +1,375 @@ +// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies). +// All rights reserved. +// This component and the accompanying materials are made available +// under the terms of "Eclipse Public License v1.0" +// which accompanies this distribution, and is available +// at the URL "http://www.eclipse.org/legal/epl-v10.html". +// +// Initial Contributors: +// Nokia Corporation - initial contribution. +// +// Contributors: +// +// Description: +// + +#include "GenericUriParser.h" + + +/** + * CGenericUriParser Constructor. + */ +CGenericUriParser::CGenericUriParser() +: CBase() + { + } + +/** + * CGenericUriParser Static Factory Construction. + */ +CGenericUriParser* CGenericUriParser::NewL() + { + CGenericUriParser* self = new (ELeave) CGenericUriParser; + CleanupStack::PushL(self); + self->ConstructL(); + CleanupStack::Pop(self); + return self; + } + +/** + Second phase of two-phase construction method. + + @pre First phase of construction is complete. + @post The object is fully constructed and initialized. + */ +void CGenericUriParser::ConstructL() + { + // Does nothing. + } + +/** + * Default Destructor. + */ +CGenericUriParser::~CGenericUriParser() + { + } + +/** + Function to parse a descriptor for a scheme component. If a scheme is found + then the output argument aScheme is set to refer to it. + + @param aUri The descriptor containing the uri to be parsed for + a scheme. + @param aScheme The output descriptor to refer to the scheme + @return The number of characters consumed in parsing the scheme. + @pre The output descriptor has been initialized so that the pointer + to the associated descriptor buffer is NULL. The input descriptor + is set to the start of the uri. + @post If a scheme component exists then the output descriptor refers + to it, otherwise the output descriptor is left unchanged. +*/ +TInt CGenericUriParser::ParseScheme(const TPtrC8& aUri, TPtrC8& aScheme) + { + // Get the descriptor and look for scheme delimiter + TInt consumed =0; + TInt endSchemePos = FindFirstUriDelimiter(aUri, ESchemeDelimiterSearch); + + if( endSchemePos != KErrNotFound ) + { + // Got a scheme - store information + aScheme.Set(aUri.Left(endSchemePos)); + + // Set consumed amount move past scheme delimiter + consumed = endSchemePos + 1; + } + return consumed; + } + +/** + Function to parse a descriptor for an authority component. If an authority is + found then the output arguments aUserinfo, aHost and aPort are set to refer to those parts + of the authority component. If an authority component exists then the host part exists. The + userinfo and port parts are optional. + + @param aUri The descriptor containing the uri to be parsed + for an authority. + @param aUserinfo The output descriptor for the userinfo component. + @param aHost The output descriptor for the host component. + @param aPort The output descriptor for the port component. + @param aUseNetworkDelimiter Whether the scheme uses the network delimeter '//' + @return The number of characters consumed in parsing the authority. + @pre The output descriptors have been initialized so that the pointer + to the their associated descriptor buffers is NULL. The input descriptor + is set to the start of the start of the authority component. + + @post If an authority component exists then the output descriptors refer + to the userinfo part (if exists), the host part and the port part (if exists), + otherwise the output descriptors are left unchanged. +*/ +TInt CGenericUriParser::ParseAuthority(const TPtrC8& aUri, TPtrC8& aUserinfo, TPtrC8& aHost, TPtrC8& aPort, TBool aUseNetworkDelimiter) + { + // Get uri descriptor and see if authority exists - if aUseNetworkDelimiter is true it has to start with '//' + TInt consumed =0; + const TInt prefixLength = aUseNetworkDelimiter ? KUriNetworkAuthorityDelimiterLength : 0; + if( !aUseNetworkDelimiter || + (aUri.Length() >= prefixLength && aUri[0] == KSlashDelimiter && aUri[1] == KSlashDelimiter )) + { + // There is an authority + TPtrC8 authority( aUri.Mid(prefixLength) ); + + // Authority delimited by '/', '?', '#' or the end of the string + TInt authorityEndPos = FindFirstUriDelimiter(authority, EAuthDelimiterSearch); + + // Got authority - parse it for its components + authority.Set(authority.Left(authorityEndPos)); + + // Get the userinfo... + TInt userinfoEndPos = authority.Locate(KUserinfoDelimiter); + if( userinfoEndPos != KErrNotFound ) + { + // Store the information + aUserinfo.Set(authority.Left(userinfoEndPos)); + + // Move past the userinfo and the delimiter '@' + authority.Set(authority.Mid(userinfoEndPos + 1)); + } + + // Authority is also delimited by ';' but this is valid in the userinfo so can only be checked now + TInt semicolonPos = FindFirstUriDelimiter(authority, ESemiColonDelimiterFlag); + if ( semicolonPos != KErrNotFound ) + { + authority.Set(authority.Left(semicolonPos)); + authorityEndPos = semicolonPos + userinfoEndPos + 1; + } + + // Set consumed amount to move past authority + consumed += prefixLength + authorityEndPos; + + // Check if this is an IPv6 address by looking for the opening '[' + TInt startHostIPv6 = authority.Locate(KIPv6UriOpenBrace); + + if (startHostIPv6 == KErrNotFound) + { + // This isn't an IPv6 address..... + + // Get host... + TInt hostEndPos = authority.Locate(KPortDelimiter); + + // Host also delimited by the end of the authority + if( hostEndPos == KErrNotFound ) + { + hostEndPos = authority.Length(); + } + + // There's always a host, but can be empty - store information + aHost.Set(authority.Left(hostEndPos)); + + // Move past the host + authority.Set(authority.Mid(hostEndPos)); + } + else + { + // This is an IPv6 address, so it MUST have the closing brace too.... + TInt endIPv6Host = authority.Locate(KIPv6UriCloseBrace); + + // Return an error if the closing IPv6 delimiter isn't there. + // or Host is empty + if (endIPv6Host == KErrNotFound || endIPv6Host == startHostIPv6 + 1) + { + return KUriUtilsErrInvalidUri; + } + + // It's an ipv6 address, with an opening and closing brace. So now just extract it + // auth = [X:X:X]????? + + // First, move past the opening brace + authority.Set(authority.Mid(startHostIPv6 + 1)); + // auth now = X:X:X]????? + + // Set the host, and need to remove the closing brace + aHost.Set(authority.Left(endIPv6Host - 1)); + // host = X:X:X + + // Move past the host + authority.Set(authority.Mid(endIPv6Host)); + } + + // Get the port... + TInt portEndPos = authority.Length(); + if( portEndPos ) + { + // Store the port - remove leading ':' + aPort.Set(authority.Mid(1, portEndPos - 1)); + } + } + return consumed; + } + +/** + Function to parse a descriptor for a path/parameter component.There is always a path component. + The ouput argument aPath is set to the path/parameter component found. + + @param aUri The descriptor containing the uri to be parsed for a path. + @param aComponent The output descriptor to refer to the path. + @return The number of characters consumed in parsing the path. + @pre The output descriptor has been initialized so that the pointer + to the associated descriptor buffer is NULL. The input descriptor + is set to the start of the path. + + @post The output descriptor refers to the path component. +*/ +TInt CGenericUriParser::ParsePath(const TPtrC8& aUri, TPtrC8& aComponent) + { + // Get descriptor with the path + TInt consumed =0; + + // Path is delimited by '?'. '#' or the end of the string + TInt pathEndPos = FindFirstUriDelimiter(aUri, EPathDelimiterSearch); + + // Check for presence of path + if( pathEndPos != KErrNotFound ) + { + // Got path - store information + aComponent.Set(aUri.Left(pathEndPos)); + + // Set consumed amount to move past path + consumed = pathEndPos; + } + return consumed; + } + +/** + Function to parse a descriptor for a query/header component.If a query is found then + the output argument aQuery is set to refer to it. + + @param aUri The descriptor containing the uri to be parsed for + a query. + @param aComponent The output descriptor to refer to the query + @return The number of characters consumed in parsing the query. + @pre The output descriptor has been initialized so that the pointer + to the associated descriptor buffer is NULL. The input descriptor is set to + the start of the query. + @post If a query component exists then the output descriptor refers + to it, otherwise the output descriptor is left unchanged. +*/ +TInt CGenericUriParser::ParseQuery(const TPtrC8& aUri, TPtrC8& aComponent) + { + // Get descriptor with the query + TInt consumed =0; + + // Query is delimited by '#' or end of the string + TInt queryEndPos = FindFirstUriDelimiter(aUri, EQueryDelimiterSearch); + + // Check for presence of query + if( queryEndPos ) + { + // Got query - store information; need to excluded leading '?' + aComponent.Set(aUri.Mid(1, queryEndPos - 1)); + + // Set consumed amount to move past query + consumed = queryEndPos; + } + return consumed; + } + +/** + Function to parse a descriptor for a fragment component. If a fragment is found then + the output argument aFragment is set to refer to it. + + @param aUri The descriptor containing the uri to be parsed for a fragment. + @param aComponent The output descriptor to refer to the fragment. + @return The number of characters consumed in parsing the fragment. + @pre The output descriptor has been initialized so that the pointer + to the associated descriptor buffer is NULL. The input descriptor is set to + the start of the fragment. + @post If a fragment component exists then the output descriptor refers + to it, otherwise the output descriptor is left unchanged. +*/ +TInt CGenericUriParser::ParseFragment(const TPtrC8& aUri, TPtrC8& aComponent) + { + // Get descriptor with the fragment + TInt consumed =0; + + // Fragment is delimited by end of the string + TInt fragmentEndPos = aUri.Length(); + + // Check for presence of fragment + if( fragmentEndPos ) + { + // Got fragment - store information; need to excluded leading '#' + aComponent.Set(aUri.Mid(1, fragmentEndPos - 1)); + + // Set consumed amount to move past fragment + consumed = fragmentEndPos; + } + return consumed; + } + +/** + Function to find the position of the first delimiter in the descriptor specified + by the delimiter flags. Note that the end of the descriptor is also a delimiter if there are + no others. In the case of the scheme delimiter search, the position returned depends on the + position of the colon delimiter with respect to the other delimiters for a scheme. + + @param aUri The descriptor containing the section of a uri to be searched. + @param aSearchFlag The enum specifying the delimiters to search for. + @return The position of nearest delimiter to start of the descriptor, where + zero is the start (left-most) position. +*/ +TInt CGenericUriParser::FindFirstUriDelimiter(const TPtrC8& aUri, TDelimiterSearchFlag aSearchFlag) + { + // Set ultimate delimiter - string length + TInt endPos = aUri.Length(); + if( aSearchFlag & EHashDelimiterFlag ) + { + TInt fragmentPos = aUri.Locate(KFragmentDelimiter); + if( fragmentPos != KErrNotFound && fragmentPos < endPos ) + { + endPos = fragmentPos; + } + } + if( aSearchFlag & EQueryDelimiterFlag ) + { + TInt queryPos = aUri.Locate(KQueryDelimiter); + if( queryPos != KErrNotFound && queryPos < endPos ) + { + endPos = queryPos; + } + } + if( aSearchFlag & ESlashDelimiterFlag ) + { + TInt slashPos = aUri.Locate(KSlashDelimiter); + if( slashPos != KErrNotFound && slashPos < endPos ) + { + endPos = slashPos; + } + } + if( aSearchFlag & ESemiColonDelimiterFlag ) + { + TInt semiColonPos = aUri.Locate(KParamDelimiter); + if( semiColonPos != KErrNotFound && semiColonPos < endPos ) + { + endPos = semiColonPos; + } + } + if( aSearchFlag & EColonDelimiterFlag ) + { + TInt schemePos = aUri.Locate(KSchemeDelimiter); + if( schemePos != KErrNotFound && schemePos < endPos ) + { + // There is a scheme + endPos = schemePos; + } + else if( aSearchFlag == ESchemeDelimiterSearch ) + { + // Ok different if looking for scheme delimiter - no scheme, return KErrNotFound + endPos = KErrNotFound; + } + } + return endPos; + } + + + + +