/usr/include/osipparser2/osip_uri.h is in libosip2-dev 4.1.0-2.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 | /*
The oSIP library implements the Session Initiation Protocol (SIP -rfc3261-)
Copyright (C) 2001-2012 Aymeric MOIZARD amoizard@antisip.com
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef _URLS_H_
#define _URLS_H_
#include <osipparser2/osip_const.h>
#include <osipparser2/osip_list.h>
/**
* @file osip_uri.h
* @brief oSIP url parser Routines
*
* This is the implementation of sip url scheme. It also partially support
* any unrecognised scheme (not starting with 'sip:' or 'sips:'). Unrecognised
* scheme are stored in url->string.
*/
/**
* @defgroup oSIP_URLS oSIP url parser Handling
* @ingroup osip2_parser
* @{
*/
#ifdef __cplusplus
extern "C" {
#endif
/**
* Structure for referencing url parameters.
* @var osip_uri_param_t
*/
typedef struct osip_uri_param osip_uri_param_t;
/**
* Structure for referencing url parameters.
* @struct osip_uri_param
*/
struct osip_uri_param {
char *gname; /**< uri parameter name */
char *gvalue;
/**< uri parameter value */
};
/**
* Structure for referencing url headers.
* @var osip_uri_header_t
*/
typedef osip_uri_param_t osip_uri_header_t;
/**
* Allocate a url parameter element.
* @param url_param The element to work on.
*/
int osip_uri_param_init (osip_uri_param_t ** url_param);
/**
* Free a url parameter element.
* @param url_param The element to work on.
*/
void osip_uri_param_free (osip_uri_param_t * url_param);
/**
* Set values of a url parameter element.
* @param url_param The element to work on.
* @param name The token name.
* @param value The token value.
*/
int osip_uri_param_set (osip_uri_param_t * url_param, char *name, char *value);
/**
* Clone a url parameter element.
* @param url_param The element to work on.
* @param dest The resulting new allocated element.
*/
int osip_uri_param_clone (const osip_uri_param_t * url_param, osip_uri_param_t ** dest);
#ifndef DOXYGEN
/*
* Free a list of a url parameter element.
* @param url_params The list of url parameter element to free.
*/
void osip_uri_param_freelist (osip_list_t * url_params);
#endif
/**
* Allocate and add a url parameter element in a list.
* @param url_params The list of url parameter element to work on.
* @param name The token name.
* @param value The token value.
*/
int osip_uri_param_add (osip_list_t * url_params, char *name, char *value);
/**
* Find in a url parameter element in a list.
* @param url_params The list of url parameter element to work on.
* @param name The name of the parameter element to find.
* @param dest A pointer on the element found.
*/
int osip_uri_param_get_byname (osip_list_t * url_params, char *name, osip_uri_param_t ** dest);
/**
* Allocate a generic parameter element.
* @param url_header The element to work on.
*/
#define osip_uri_header_init(url_header) osip_uri_param_init(url_header)
/**
* Free a generic parameter element.
* @param url_header The element to work on.
*/
#define osip_uri_header_free(url_header) osip_uri_param_free(url_header)
/**
* Set values of a generic parameter element.
* @param url_header The element to work on.
* @param name The token name.
* @param value The token value.
*/
#define osip_uri_header_set(url_header, name, value) osip_uri_param_set(url_header, name, value)
/**
* Clone a generic parameter element.
* @param url_header The element to work on.
* @param dest The resulting new allocated element.
*/
#define osip_uri_header_clone(url_header,dest) osip_uri_param_clone(url_header,dest)
#ifndef DOXYGEN
/*
* Free a list of a generic parameter element.
* @param LIST The list of generic parameter element to free.
*/
#define osip_uri_header_freelist(LIST) osip_uri_param_freelist(LIST)
#endif
/**
* Allocate and add a generic parameter element in a list.
* @param url_headers The list of generic parameter element to work on.
* @param name The token name.
* @param value The token value.
*/
#define osip_uri_header_add(url_headers,name,value) osip_uri_param_add(url_headers,name,value)
/**
* Find in a generic parameter element in a list.
* @param url_headers The list of generic parameter element to work on.
* @param name The name of the parameter element to find.
* @param dest A pointer on the element found.
*/
#define osip_uri_header_get_byname(url_headers,name,dest) osip_uri_param_get_byname(url_headers,name,dest)
/**
* Structure for referencing SIP urls.
* @var osip_uri_t
*/
typedef struct osip_uri osip_uri_t;
/**
* Structure for referencing SIP urls.
* @struct osip_uri
*/
struct osip_uri {
char *scheme; /**< Uri Scheme (sip or sips) */
char *username; /**< Username */
char *password; /**< Password */
char *host; /**< Domain */
char *port; /**< Port number */
osip_list_t url_params; /**< Uri parameters */
osip_list_t url_headers;
/**< Uri headers */
char *string;
/**< Space for other url schemes. (http, mailto...) */
};
/**
* Allocate a url element.
* @param url The element to work on.
*/
int osip_uri_init (osip_uri_t ** url);
/**
* Free a url element.
* @param url The element to work on.
*/
void osip_uri_free (osip_uri_t * url);
/**
* Parse a url.
* @param url The element to work on.
* @param buf The buffer to parse.
*/
int osip_uri_parse (osip_uri_t * url, const char *buf);
#ifndef DOXYGEN
/**
* Parse the header part of a url.
* @param url The element to work on.
* @param buf The buffer to parse.
*/
int osip_uri_parse_headers (osip_uri_t * url, const char *buf);
/**
* Parse the parameter part of a url.
* @param url The element to work on.
* @param buf The buffer to parse.
*/
int osip_uri_parse_params (osip_uri_t * url, const char *buf);
#endif
/**
* Get a string representation of a url element.
* @param url The element to work on.
* @param dest The resulting new allocated buffer.
*/
int osip_uri_to_str (const osip_uri_t * url, char **dest);
/**
* Clone a url element.
* @param url The element to work on.
* @param dest The resulting new allocated element.
*/
int osip_uri_clone (const osip_uri_t * url, osip_uri_t ** dest);
/**
* Get a canonical string representation of a url element.
* as defined in 10.3-5
* @param url The element to work on.
* @param dest The resulting new allocated buffer.
*/
int osip_uri_to_str_canonical (const osip_uri_t * url, char **dest);
/**
* Set the scheme of a url element.
* @param url The element to work on.
* @param value The token value.
*/
void osip_uri_set_scheme (osip_uri_t * url, char *value);
/**
* Get the scheme of a url element.
* @param url The element to work on.
*/
char *osip_uri_get_scheme (osip_uri_t * url);
/**
* Set the host of a url element.
* @param url The element to work on.
* @param value The token value.
*/
void osip_uri_set_host (osip_uri_t * url, char *value);
/**
* Get the host of a url element.
* @param url The element to work on.
*/
char *osip_uri_get_host (osip_uri_t * url);
/**
* Set the username of a url element.
* @param url The element to work on.
* @param value The token value.
*/
void osip_uri_set_username (osip_uri_t * url, char *value);
/**
* Get the username of a url element.
* @param url The element to work on.
*/
char *osip_uri_get_username (osip_uri_t * url);
/**
* Set the password of a url element.
* @param url The element to work on.
* @param value The token value.
*/
void osip_uri_set_password (osip_uri_t * url, char *value);
/**
* Get the password of a url element.
* @param url The element to work on.
*/
char *osip_uri_get_password (osip_uri_t * url);
/**
* Set the port of a url element.
* @param url The element to work on.
* @param value The token value.
*/
void osip_uri_set_port (osip_uri_t * url, char *value);
/**
* Get the port of a url element.
* @param url The element to work on.
*/
char *osip_uri_get_port (osip_uri_t * url);
/**
* Set the transport parameter to UDP in a url element.
* @param url The element to work on.
*/
#define osip_uri_set_transport_udp(url) osip_uri_param_add((&(url)->url_params), osip_strdup("transport"), osip_strdup("udp"))
/**
* Set the transport parameter to TCP in a url element.
* @param url The element to work on.
*/
#define osip_uri_set_transport_tcp(url) osip_uri_param_add((&(url)->url_params), osip_strdup("transport"), osip_strdup("tcp"))
/**
* Set the transport parameter to SCTP in a url element.
* @param url The element to work on.
*/
#define osip_uri_set_transport_sctp(url) osip_uri_param_add((&(url)->url_params), osip_strdup("transport"), osip_strdup("sctp"))
/**
* Set the transport parameter to TLS in a url element.
* @param url The element to work on.
*/
#define osip_uri_set_transport_tls(url) osip_uri_param_add((&(url)->url_params), osip_strdup("transport"), osip_strdup("tls"))
/**
* Set the transport parameter to TLS in a url element.
* @param url The element to work on.
* @param value The value describing the transport protocol.
*/
#define osip_uri_set_transport(url,value) osip_uri_param_add((&(url)->url_params), osip_strdup("transport"), value)
/**
* Set the user parameter to PHONE in a url element.
* @param url The element to work on.
*/
#define osip_uri_set_user_phone(url) osip_uri_param_add((&(url)->url_params), osip_strdup("user"), osip_strdup("phone"))
/**
* Set the user parameter to IP in a url element.
* @param url The element to work on.
*/
#define osip_uri_set_user_ip(url) osip_uri_param_add((&(url)->url_params), osip_strdup("user"), osip_strdup("ip"))
/**
* Set a method parameter to INVITE in a url element.
* @param url The element to work on.
*/
#define osip_uri_set_method_invite(url) osip_uri_param_add((&(url)->url_params), osip_strdup("method"), osip_strdup("INVITE"))
/**
* Set a method parameter to ACK in a url element.
* @param url The element to work on.
*/
#define osip_uri_set_method_ack(url) osip_uri_param_add((&(url)->url_params), osip_strdup("method"), osip_strdup("ACK"))
/**
* Set a method parameter to OPTIONS in a url element.
* @param url The element to work on.
*/
#define osip_uri_set_method_options(url) osip_uri_param_add((&(url)->url_params), osip_strdup("method"), osip_strdup("OPTIONS"))
/**
* Set a method parameter to BYE in a url element.
* @param url The element to work on.
*/
#define osip_uri_set_method_bye(url) osip_uri_param_add((&(url)->url_params), osip_strdup("method"), osip_strdup("BYE"))
/**
* Set a method parameter to CANCEL in a url element.
* @param url The element to work on.
*/
#define osip_uri_set_method_cancel(url) osip_uri_param_add((&(url)->url_params), osip_strdup("method"), osip_strdup("CANCEL"))
/**
* Set a method parameter to REGISTER in a url element.
* @param url The element to work on.
*/
#define osip_uri_set_method_register(url) osip_uri_param_add((&(url)->url_params),osip_strdup("method"), osip_strdup("REGISTER"))
/**
* Set a method parameter in a url element.
* @param url The element to work on.
* @param value The value for the method parameter.
*/
#define osip_uri_set_method(url, value) osip_uri_param_add((&(url)->url_params), osip_strdup("method"), value)
/**
* Set a ttl parameter in a url element.
* @param url The element to work on.
* @param value The value for the ttl parameter.
*/
#define osip_uri_set_ttl(url, value) osip_uri_param_add((&(url)->url_params), osip_strdup("ttl"), value)
/**
* Set a maddr parameter in a url element.
* @param url The element to work on.
* @param value The value for the maddr parameter.
*/
#define osip_uri_set_maddr(url, value) osip_uri_param_add((&(url)->url_params), osip_strdup("maddr"), value)
/**
* Allocate and add a url parameter element in a url element.
* @param url The element to work on.
* @param name The token name.
* @param value The token value.
*/
#define osip_uri_uparam_add(url,name,value) osip_uri_param_add((&(url)->url_params),name,value)
/**
* Find in a url parameter element in a url element.
* @param url The element to work on.
* @param name The name of the url parameter element to find.
* @param dest A pointer on the element found.
*/
#define osip_uri_uparam_get_byname(url,name,dest) osip_uri_param_get_byname((&(url)->url_params),name,dest)
/**
* Allocate and add a url header element in a url element.
* @param url The element to work on.
* @param name The token name.
* @param value The token value.
*/
#define osip_uri_uheader_add(url,name,value) osip_uri_header_add((&(url)->url_headers),name,value)
/**
* Find in a url header element in a url element.
* @param url The element to work on.
* @param name The name of the url header element to find.
* @param dest A pointer on the element found.
*/
#define osip_uri_uheader_get_byname(url,name,dest) osip_uri_header_get_byname((&(url)->url_headers),name,dest)
#ifndef DOXYGEN
/* internal method */
char *next_separator (const char *ch, int separator_osip_to_find, int before_separator);
char *__osip_uri_escape_nonascii_and_nondef (const char *string, const char *def);
char *__osip_uri_escape_userinfo (const char *string);
char *__osip_uri_escape_password (const char *string);
char *__osip_uri_escape_uri_param (char *string);
char *__osip_uri_escape_header_param (char *string);
void __osip_uri_unescape (char *string);
#endif
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* _URLS_H_ */
|