url.h

Go to the documentation of this file.

/*
 * This file is part of the Sofia-SIP package
 *
 * Copyright (C) 2005 Nokia Corporation.
 *
 * Contact: Pekka Pessi <pekka.pessi@nokia-email.address.hidden>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */
 
#ifndef URL_H_TYPES
#define URL_H_TYPES
 
enum url_type_e {
  url_invalid = -2, 
  url_unknown = -1, 
  url_any = 0,      
  url_sip,      
  url_sips,     
  url_urn,      
  url_tel,      
  url_fax,      
  url_modem,        
  url_http,     
  url_https,        
  url_ftp,      
  url_file,     
  url_rtsp,     
  url_rtspu,        
  url_mailto,       
  url_im,       
  url_pres,     
  url_cid,      
  url_msrp,     
  url_msrps,        
  url_wv,       
  _url_none
};
 
typedef struct {
  char                url_pad[sizeof(void *) - 2];
  signed char         url_type;     
  char                url_root;     
  char const         *url_scheme;   
  char const         *url_user;     
  char const         *url_password; 
  char const         *url_host;     
  char const         *url_port;     
  char const         *url_path;     
  char const         *url_params;   
  char const         *url_headers;  
  char const         *url_fragment; 
} url_t;
 
enum {
  URL_MAXLEN = 65536
};
 
typedef union {
  char  us_str[URL_MAXLEN]; 
  url_t us_url[1];      
} url_string_t;
 
#endif
 
#ifndef URL_H
#define URL_H
 
#ifndef SU_ALLOC_H
#include <sofia-sip/su_alloc.h>
#endif
 
SOFIA_BEGIN_DECLS
 
SOFIAPUBFUN url_t *url_make(su_home_t *h, char const *str);
 
SOFIAPUBFUN url_t *url_format(su_home_t *h, char const *fmt, ...);
 
SOFIAPUBFUN char *url_as_string(su_home_t *home, url_t const *url);
 
SOFIAPUBFUN url_t *url_hdup(su_home_t *h, url_t const *src);
 
SOFIAPUBFUN int url_sanitize(url_t *u);
 
SOFIAPUBFUN char const *url_scheme(enum url_type_e type);
 
/* ---------------------------------------------------------------------- */
/* URL comparison */
 
SOFIAPUBFUN int url_cmp(url_t const *a, url_t const *b);
 
SOFIAPUBFUN int url_cmp_all(url_t const *a, url_t const *b);
 
/* ---------------------------------------------------------------------- */
/* Parameter handling */
 
SOFIAPUBFUN isize_t url_param(char const *params, char const *tag,
                  char value[], isize_t vlen);
 
SOFIAPUBFUN int url_has_param(url_t const *url, char const *name);
 
SOFIAPUBFUN isize_t url_have_param(char const *params, char const *tag);
 
SOFIAPUBFUN int url_param_add(su_home_t *h, url_t *url, char const *param);
 
SOFIAPUBFUN int url_strip_transport(url_t *u);
 
SOFIAPUBFUN char *url_strip_param_string(char *params, char const *name);
 
SOFIAPUBFUN int url_have_transport(url_t const *u);
 
/* ---------------------------------------------------------------------- */
/* Query handling */
 
SOFIAPUBFUN char *url_query_as_header_string(su_home_t *home,
                         char const *query);
 
/* ---------------------------------------------------------------------- */
/* Handling url-escque strings */
 
SOFIAPUBFUN int url_reserved_p(char const *s);
 
SOFIAPUBFUN char *url_escape(char *d, char const *s, char const reserved[]);
 
SOFIAPUBFUN isize_t url_esclen(char const *s, char const reserved[]);
 
SOFIAPUBFUN size_t url_unescape_to(char *d, char const *s, size_t n);
 
SOFIAPUBFUN char *url_unescape(char *d, char const *s);
 
#define URL_RESERVED_CHARS ";/?:@&=+$,"
 
/* ---------------------------------------------------------------------- */
/* Initializing */
 
#define URL_INIT_AS(type)  \
  { "\0", url_##type, 0, url_##type != url_any ? #type : "*" }
 
SOFIAPUBFUN void url_init(url_t *url, enum url_type_e type);
 
/* ---------------------------------------------------------------------- */
/* Resolving helpers */
 
SOFIAPUBFUN char const *url_port_default(enum url_type_e url_type);
 
SOFIAPUBFUN char const *url_tport_default(enum url_type_e url_type);
 
SOFIAPUBFUN char const *url_port(url_t const *u);
 
#define URL_PORT(u) \
  ((u) && (u)->url_port ? (u)->url_port : \
  url_port_default((u) ? (enum url_type_e)(u)->url_type : url_any))
 
/* ---------------------------------------------------------------------- */
/* url_string_t handling */
 
#define URL_STRING_P(u) ((u) && *((url_string_t*)(u))->us_str != 0)
 
#define URL_IS_STRING(u) ((u) && *((url_string_t*)(u))->us_str != 0)
 
SOFIAPUBFUN int url_string_p(url_string_t const * url);
 
SOFIAPUBFUN int url_is_string(url_string_t const * url);
 
#define URL_STRING_MAKE(s) \
  ((url_string_t *)((s) && *((char *)(s)) ? (s) : NULL))
 
/* ---------------------------------------------------------------------- */
/* Printing URL */
 
#define URL_PRINT_FORMAT "%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s"
#define URL_FORMAT_STRING URL_PRINT_FORMAT
 
#define URL_PRINT_ARGS(u) \
  (u)->url_scheme ? (u)->url_scheme : "",   \
  (u)->url_type != url_any && (u)->url_scheme && (u)->url_scheme[0] \
    ? ":" : "", \
  (u)->url_root && ((u)->url_host || (u)->url_user) ? "//" : "", \
  (u)->url_user ? (u)->url_user : "", \
  (u)->url_user && (u)->url_password ? ":" : "", \
  (u)->url_user && (u)->url_password ? (u)->url_password : "", \
  (u)->url_user && (u)->url_host ? "@" : "", \
  (u)->url_host ? (u)->url_host : "", \
  (u)->url_host && (u)->url_port ? ":" : "", \
  (u)->url_host && (u)->url_port ? (u)->url_port : "", \
  (u)->url_root && (u)->url_path ? "/" : "", \
  (u)->url_path ? (u)->url_path : "", \
  (u)->url_params ? ";" : "", (u)->url_params ? (u)->url_params : "", \
  (u)->url_headers ? "?" : "", (u)->url_headers ? (u)->url_headers : "", \
  (u)->url_fragment ? "#" : "", (u)->url_fragment ? (u)->url_fragment : ""
 
/* ---------------------------------------------------------------------- */
/* URL digests */
 
struct su_md5_t;
 
SOFIAPUBFUN void url_update(struct su_md5_t *md5, url_t const *url);
 
SOFIAPUBFUN void url_digest(void *hash, int hsize,
                url_t const *, char const *key);
 
/* ---------------------------------------------------------------------- */
/* Parsing and manipulating URLs */
 
SOFIAPUBFUN int url_d(url_t *url, char *s);
 
SOFIAPUBFUN isize_t url_len(url_t const * url);
 
SOFIAPUBFUN issize_t url_e(char buffer[], isize_t n, url_t const *url);
 
#define URL_E(buf, end, url) \
  (buf) += url_e((buf), (buf) < (end) ? (end) - (buf) : 0, (url))
 
SOFIAPUBFUN isize_t url_xtra(url_t const * url);
 
SOFIAPUBFUN issize_t url_dup(char *, isize_t , url_t *dst, url_t const *src);
 
#define URL_DUP(buf, end, dst, src) \
  (buf) += url_dup((buf), (isize_t)((buf) < (end) ? (end) - (buf) : 0), (dst), (src))
 
SOFIA_END_DECLS
#endif