uri.h
Go to the documentation of this file.
/*******************************************************************************
*
* Copyright (c) 2000-2003 Intel Corporation
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* - Neither name of Intel Corporation nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
******************************************************************************/
#ifndef GENLIB_NET_URI_H
#define GENLIB_NET_URI_H
#if !defined(_WIN32)
#include <sys/param.h>
#endif
#include "UpnpGlobal.h" /* for */
#include "UpnpInet.h"
#include <ctype.h>
#include <errno.h>
#include <fcntl.h>
#include <stdlib.h>
#include <string.h>
#include <sys/types.h>
#include <time.h>
#ifdef _WIN32
#if !defined(UPNP_USE_MSVCPP) && !defined(UPNP_USE_BCBPP)
/* VC Winsocks2 includes these functions */
#include "inet_pton.h"
#endif
#else
#include <netdb.h> /* for struct addrinfo */
#endif
#ifdef _WIN32
#define strncasecmp strnicmp
#else
/* Other systems have strncasecmp */
#endif
#ifdef __cplusplus
extern "C" {
#endif
#define MARK "-_.!~*'()"
#define RESERVED ";/?:@&=+$,{}"
#define HTTP_SUCCESS 1
enum hostType
{
HOSTNAME,
IPv4address
};
enum pathType
{
ABS_PATH,
REL_PATH,
OPAQUE_PART
};
#ifdef _WIN32
/* there is a conflict in windows with other symbols. */
enum uriType
{
absolute,
relative
};
#else
enum uriType
{
ABSOLUTE,
RELATIVE
};
#endif
typedef struct TOKEN
{
const char *buff;
size_t size;
} token;
typedef struct HOSTPORT
{
token text;
/* Network Byte Order */
struct sockaddr_storage IPaddress;
} hostport_type;
typedef struct URI
{
enum uriType type;
token scheme;
enum pathType path_type;
token pathquery;
token fragment;
hostport_type hostport;
} uri_type;
typedef struct URL_LIST
{
size_t size;
char *URLs;
uri_type *parsedURLs;
} URL_list;
int replace_escaped(
char *in,
size_t index,
size_t *max);
int copy_URL_list(
URL_list *in,
URL_list *out);
void free_URL_list(
URL_list *list);
#ifdef DEBUG
void print_uri(
uri_type *in);
#else
#define print_uri(in) \
do { \
} while (0)
#endif
#ifdef DEBUG
void print_token(
token *in);
#else
#define print_token(in) \
do { \
} while (0)
#endif
int token_string_casecmp(
token *in1,
const char *in2);
int token_cmp(
token *in1,
token *in2);
int remove_escaped_chars(
char *in,
size_t *size);
int remove_dots(
char *in,
size_t size);
char *resolve_rel_url(
char *base_url,
char *rel_url);
int parse_uri(
const char *in,
size_t max,
uri_type *out);
int parse_token(
char *in,
token *out,
int max_size);
#ifdef __cplusplus
}
#endif
#endif /* GENLIB_NET_URI_H */
UpnpGlobal.h
Defines constants that for some reason are not defined on some systems.
UpnpInet.h
Provides a platform independent way to include TCP/IP types and functions.
HOSTPORT
Represents a host port: e.g. "127.127.0.1:80" text is a token pointing to the full string representat...
Definition uri.h:123
HOSTPORT::text
token text
Definition uri.h:125
TOKEN
Buffer used in parsinghttp messages, urls, etc. generally this simply holds a pointer into a larger a...
Definition uri.h:113
URI
Represents a URI used in parse_uri and elsewhere.
Definition uri.h:134
URL_LIST
Represents a list of URLs as in the "callback" header of SUBSCRIBE message in GENA....
Definition uri.h:148
URL_LIST::URLs
char * URLs
Definition uri.h:152
resolve_rel_url
char * resolve_rel_url(char *base_url, char *rel_url)
resolves a relative url with a base url returning a NEW (dynamically allocated with malloc) full url.
Definition uri.c:581
parse_token
int parse_token(char *in, token *out, int max_size)
URL_list
struct URL_LIST URL_list
Represents a list of URLs as in the "callback" header of SUBSCRIBE message in GENA....
copy_URL_list
int copy_URL_list(URL_list *in, URL_list *out)
Copies one URL_list into another.
Definition uri.c:210
token
struct TOKEN token
Buffer used in parsinghttp messages, urls, etc. generally this simply holds a pointer into a larger a...
replace_escaped
int replace_escaped(char *in, size_t index, size_t *max)
Replaces an escaped sequence with its unescaped version as in http://www.ietf.org/rfc/rfc2396....
Definition uri.c:128
remove_dots
int remove_dots(char *in, size_t size)
Removes ".", and ".." from a path.
Definition uri.c:513
token_cmp
int token_cmp(token *in1, token *in2)
Compares two tokens.
Definition uri.c:296
hostport_type
struct HOSTPORT hostport_type
Represents a host port: e.g. "127.127.0.1:80" text is a token pointing to the full string representat...
token_string_casecmp
int token_string_casecmp(token *in1, const char *in2)
Compares buffer in the token object with the buffer in in2.
Definition uri.c:287
uri_type
struct URI uri_type
Represents a URI used in parse_uri and elsewhere.
remove_escaped_chars
int remove_escaped_chars(char *in, size_t *size)
Removes http escaped characters such as: "%20" and replaces them with their character representation....
Definition uri.c:489
print_uri
void print_uri(uri_type *in)
Function useful in debugging for printing a parsed uri.
print_token
void print_token(token *in)
Function useful in debugging for printing a token.
parse_uri
int parse_uri(const char *in, size_t max, uri_type *out)
Parses a uri as defined in http://www.ietf.org/rfc/rfc2396.txt (RFC explaining URIs).
Definition uri.c:727
free_URL_list
void free_URL_list(URL_list *list)
Frees the memory associated with a URL_list.
Definition uri.c:254