uri.h File Reference

Uniform Resource Identifier (URI) parsing utilities declarations. More...

#include "rnr/rnrconfig.h"

Go to the source code of this file.

Classes
struct	uri_struct_t

Macros
#define	URI_SEP_SCHEME   "://"
	scheme separator
#define	URI_SEP_SCHEME_LEN   3
	scheme separator length
#define	URI_SEP_USER_PASSWORD   ":"
	user info password separator
#define	URI_SEP_USER_PASSWORD_LEN   1
	user info password separator length
#define	URI_SEP_USER_INFO   "@"
	user info separator
#define	URI_SEP_USER_INFO_LEN   1
	user info separator length
#define	URI_SEP_PORT   ":"
	port number separator
#define	URI_SEP_PORT_LEN   1
	port number separator length
#define	URI_SEP_PATH   "/"
	absolute path separator and start
#define	URI_SEP_PATH_LEN   1
	absolute path separator length
#define	URI_SEP_QUERY   "?"
	query separator
#define	URI_SEP_QUERY_LEN   1
	query separator length
#define	URI_PORT_MAX_LEN   5
	port max string length (2 bytes)
#define	URI_SCHEME_FILE   "file"
	file scheme
#define	URI_LOCAL_HOST   "localhost"
	default local hostname
#define	URI_PORT_NONE   0
	no port number

Typedefs
typedef struct uri_struct_t	Uri_T

Functions
Uri_T *	UriParseNew (const char *sUri)
	Parse a URI string. More...
char *	UriParseHostNew (const char *sHost, char **pHostName, int *pPortNum)
	Parse the host string. More...
void	UriSetScheme (Uri_T *pUri, const char *sScheme)
	Set the scheme. More...
void	UriSetHostName (Uri_T *pUri, const char *sHostName)
	Set the hostname. More...
void	UriSetPortNum (Uri_T *pUri, int nPortNum)
	Set the port number. More...
void	UriSetPath (Uri_T *pUri, const char *sPath)
	Set the file path. More...
char *	UriStrNew (const Uri_T *pUri)
	Construct a new URI string from the given URI components. More...
void	UriDelete (Uri_T *pUri)
	Delete the URI compenent structure. More...

Detailed Description

Uniform Resource Identifier (URI) parsing utilities declarations.

URI Components: scheme://userinfo@hostname:port/path?query

Package

RoadNarrows Robotics Common Library 1

Library

librnr

File

rnr/uri.h

Author

Robin Knight (robin.nosp@m..kni.nosp@m.ght@r.nosp@m.oadn.nosp@m.arrow.nosp@m.s.co.nosp@m.m)

Copyright

© 2011-2018. RoadNarrows LLC..
http://www.roadnarrows.com
All Rights Reserved

License

MIT

EULA

See the README and EULA files for any copyright and licensing information.

—

Definition in file uri.h.

Typedef Documentation

typedef struct uri_struct_t Uri_T

URI Component Parts Structure.

Function Documentation

void UriDelete

(

Uri_T *

pUri

)

Delete the URI compenent structure.

Parameters

pUri	Pointer to allocated Uri_T.

Definition at line 397 of file uri.c.

References uri_struct_t::m_sHostName, uri_struct_t::m_sPath, uri_struct_t::m_sQuery, uri_struct_t::m_sScheme, uri_struct_t::m_sUserInfo, and NULL.

Referenced by main().

{
  if( pUri == NULL )
  {
    return;
  }

  if( pUri->m_sScheme != NULL )
  {
    delete(pUri->m_sScheme);
  }

  if( pUri->m_sUserInfo != NULL )
  {
    delete(pUri->m_sUserInfo);
  }

  if( pUri->m_sHostName != NULL )
  {
    delete(pUri->m_sHostName);
  }

  if( pUri->m_sPath != NULL )
  {
    delete(pUri->m_sPath);
  }

  if( pUri->m_sQuery != NULL )
  {
    delete(pUri->m_sQuery);
  }

  delete(pUri);
}

char* UriParseHostNew	(	const char *	sHost,
		char **	pHostName,
		int *	pPortNum
	)

Parse the host string.

If no hostname is specified, NULL is set. If no port number is specified, URI_PORT_NONE is set.

Format:

hostname:port...

Parameters

	sHost	Host string.
[out]	pHostName	Pointer to the allocated parsed host name string.
[out]	pPortNum	Pointer to the parsed port number.

Returns

Returns pointer to the first character after the host substring. If sHost is NULL, NULL is return. If now URI components follow the host string, will point to the end terminator of sHost.

Definition at line 183 of file uri.c.

References new_strndup(), NULL, URI_PORT_NONE, URI_SEP_PATH, URI_SEP_PORT, and URI_SEP_QUERY.

Referenced by UriParseNew().

{
  char   *s;    // working host string head pointer
  char   *t;    // working host string tail pointer
  size_t  n;    // size of host string component

  *pHostName  = NULL;
  *pPortNum   = URI_PORT_NONE;

  if( sHost == NULL )
  {
    return NULL;
  }

  if( ((t = strstr(sHost, URI_SEP_PATH)) == NULL) && 
      ((t = strstr(sHost, URI_SEP_QUERY)) == NULL) )
  {
    t = (char *)sHost + strlen(sHost);
  }

  if( (s = strstr(sHost, URI_SEP_PORT)) == NULL )
  {
    s = t;
  }

  n = (size_t)(s - sHost);

  if( n > 0 )
  {
    *pHostName = new_strndup(sHost, n);
  }

  if( s+1 < t )
  {
    *pPortNum = (int)strtol(s+1, NULL, 10);
  }
  
  return t;
}

Uri_T* UriParseNew

(

const char *

sUri

)

Parse a URI string.

Any URI string components not found are set to NULL. If no port is specified, the port number is set to URI_PORT_NONE (0).

The Uri_T structure is allocated. The calling application owns the structure. See UriDelete().

Format:

scheme://userinfo@hostname:port/path/to/something?query&field=val...

Parameters

sUri	URI string.

Returns

Allocated and assigned Uri_T *.

Definition at line 70 of file uri.c.

References uri_struct_t::m_nPortNum, uri_struct_t::m_sHostName, uri_struct_t::m_sPath, uri_struct_t::m_sQuery, uri_struct_t::m_sScheme, uri_struct_t::m_sUserInfo, NEW, new_strdup(), new_strndup(), NULL, URI_SEP_PATH, URI_SEP_PATH_LEN, URI_SEP_QUERY, URI_SEP_QUERY_LEN, URI_SEP_SCHEME, URI_SEP_SCHEME_LEN, URI_SEP_USER_INFO, URI_SEP_USER_INFO_LEN, and UriParseHostNew().

Referenced by main().

{
  Uri_T  *pUri = NEW(Uri_T);      // new uri structure, initialized to 0 (null)
  char   *s    = (char *)sUri;    // working uri string head pointer
  char   *t;                      // working uri string tail pointer
  size_t  n;                      // size of uri string component

  // scheme://
  if( (t = strstr(s, URI_SEP_SCHEME)) != NULL )
  {
    n = (size_t)(t - s);

    if( n > 0 )
    {
      pUri->m_sScheme = new_strndup(s, n);
    }

    s = t + URI_SEP_SCHEME_LEN;
  }

  if( *s == 0 )
  {
    return pUri;
  }

  // userinfo@
  if( (t = strstr(s, URI_SEP_USER_INFO)) != NULL )
  {
    n = (size_t)(t - s);

    if( n > 0 )
    {
      pUri->m_sUserInfo = new_strndup(s, n);
    }

    s = t + URI_SEP_USER_INFO_LEN;
  }

  if( *s == 0 )
  {
    return pUri;
  }

  // hostname:port 
  s = UriParseHostNew(s, &(pUri->m_sHostName), &(pUri->m_nPortNum));

  if( *s == 0 )
  {
    return pUri;
  }

  // /path?query
  if( !strncmp(s, URI_SEP_PATH, (size_t)URI_SEP_PATH_LEN) )
  {
    if( *s == 0 )
    {
      return pUri;
    }

    if( (t = strstr(s, URI_SEP_QUERY)) != NULL )
    {
      n = (size_t)(t - s);

      if( n > 0 )
      {
        pUri->m_sPath = new_strndup(s, n);
      }

      s = t + URI_SEP_QUERY_LEN;

      if( *s != 0 )
      {
        pUri->m_sQuery = new_strdup(s);
      }
    }
    else
    {
      pUri->m_sPath = new_strdup(s);
    }
  }

  // ?query
  if( !strncmp(s, URI_SEP_QUERY, (size_t)URI_SEP_QUERY_LEN) )
  {
    s += URI_SEP_QUERY_LEN;

    if( *s != 0 )
    {
      pUri->m_sQuery = new_strdup(s);
    }
  }

  return pUri;
}

void UriSetHostName	(	Uri_T *	pUri,
		const char *	sHostName
	)

Set the hostname.

Parameters

pUri	URI scheme.
sHostName	New hostname.

Definition at line 254 of file uri.c.

References uri_struct_t::m_sHostName, new_strdup(), and NULL.

{
  if( pUri == NULL )
  {
    return;
  }

  if( pUri->m_sHostName != NULL )
  {
    delete(pUri->m_sHostName);
    pUri->m_sHostName = NULL;
  }

  if( (sHostName != NULL) && (*sHostName != 0) )
  {
    pUri->m_sHostName = new_strdup(sHostName);
  }
}

void UriSetPath	(	Uri_T *	pUri,
		const char *	sPath
	)

Set the file path.

Parameters

pUri	URI scheme.
sPath	New scheme.

Definition at line 295 of file uri.c.

References uri_struct_t::m_sPath, new_strdup(), and NULL.

{
  if( pUri == NULL )
  {
    return;
  }

  if( pUri->m_sPath != NULL )
  {
    delete(pUri->m_sPath);
    pUri->m_sPath = NULL;
  }

  if( (sPath != NULL) && (*sPath != 0) )
  {
    pUri->m_sPath = new_strdup(sPath);
  }
}

void UriSetPortNum	(	Uri_T *	pUri,
		int	nPortNum
	)

Set the port number.

Parameters

pUri	URI scheme.
nPortNum	New scheme.

Definition at line 279 of file uri.c.

References uri_struct_t::m_nPortNum, NULL, and URI_PORT_NONE.

{
  if( pUri == NULL )
  {
    return;
  }

  pUri->m_nPortNum = nPortNum >= 0? nPortNum: URI_PORT_NONE;
}

void UriSetScheme	(	Uri_T *	pUri,
		const char *	sScheme
	)

Set the scheme.

Parameters

pUri	URI scheme.
sScheme	New scheme.

Definition at line 229 of file uri.c.

References uri_struct_t::m_sScheme, new_strdup(), and NULL.

{
  if( pUri == NULL )
  {
    return;
  }

  if( pUri->m_sScheme != NULL )
  {
    delete(pUri->m_sScheme);
    pUri->m_sScheme = NULL;
  }

  if( (sScheme != NULL) && (*sScheme != 0) )
  {
    pUri->m_sScheme = new_strdup(sScheme);
  }
}

char* UriStrNew

(

const Uri_T *

pUri

)

Construct a new URI string from the given URI components.

Parameters

pUri	Pointer to URI structure.

Returns

Allocated string.

Definition at line 321 of file uri.c.

References uri_struct_t::m_nPortNum, uri_struct_t::m_sHostName, uri_struct_t::m_sPath, uri_struct_t::m_sQuery, uri_struct_t::m_sScheme, uri_struct_t::m_sUserInfo, NEWSTR, NULL, URI_PORT_MAX_LEN, URI_PORT_NONE, URI_SEP_PATH, URI_SEP_PATH_LEN, URI_SEP_PORT, URI_SEP_PORT_LEN, URI_SEP_QUERY, URI_SEP_QUERY_LEN, URI_SEP_SCHEME, URI_SEP_SCHEME_LEN, URI_SEP_USER_INFO, and URI_SEP_USER_INFO_LEN.

Referenced by main().

{
  char   *sUri;   // uri string
  Uri_T   uri = {"", "", "", 0, "", ""};
  Uri_T   sep = {"", "", "", 0, "", ""};
  char    bufPort[URI_SEP_PORT_LEN+URI_PORT_MAX_LEN+1] = {0, };
  size_t  n = 0;

  if( pUri == NULL )
  {
    return NULL;
  }

  if( pUri->m_sScheme != NULL )
  {
    n += strlen(pUri->m_sScheme) + (size_t)URI_SEP_SCHEME_LEN;
    uri.m_sScheme = pUri->m_sScheme;
    sep.m_sScheme = URI_SEP_SCHEME;
  }

  if( pUri->m_sUserInfo != NULL )
  {
    n += strlen(pUri->m_sUserInfo) + (size_t)URI_SEP_USER_INFO_LEN;
    uri.m_sUserInfo = pUri->m_sUserInfo;
    sep.m_sUserInfo = URI_SEP_USER_INFO;
  }

  if( pUri->m_sHostName != NULL )
  {
    n += strlen(pUri->m_sHostName);
    uri.m_sHostName = pUri->m_sHostName;

    if( pUri->m_nPortNum != URI_PORT_NONE )
    {
      n += (size_t)URI_SEP_PORT_LEN + (size_t)URI_PORT_MAX_LEN;
      snprintf(bufPort, sizeof(bufPort), "%s%d",
          URI_SEP_PORT, pUri->m_nPortNum);
      bufPort[sizeof(bufPort)-1] = 0;
    }
  }

  if( pUri->m_sPath != NULL )
  {
    n += strlen(pUri->m_sPath);
    uri.m_sPath = pUri->m_sPath;
    if( strncmp(uri.m_sPath, URI_SEP_PATH, URI_SEP_PATH_LEN) )
    {
      n++;
      sep.m_sPath = URI_SEP_PATH;
    }
  }

  if( pUri->m_sQuery != NULL )
  {
    n += URI_SEP_QUERY_LEN + strlen(pUri->m_sQuery);
    uri.m_sQuery = pUri->m_sQuery;
    sep.m_sQuery = URI_SEP_QUERY;
  }

  sUri = NEWSTR(n);

  sprintf(sUri, "%s%s%s%s%s%s%s%s%s%s",
      uri.m_sScheme, sep.m_sScheme,
      uri.m_sUserInfo, sep.m_sUserInfo,
      uri.m_sHostName, bufPort,
      sep.m_sPath, uri.m_sPath,
      sep.m_sQuery, uri.m_sQuery);

  return sUri;
}