sip_util.h 5.93 KB
Newer Older
Pekka Pessi's avatar
Pekka Pessi committed
1 2 3 4 5 6 7
/*
 * This file is part of the Sofia-SIP package
 *
 * Copyright (C) 2005 Nokia Corporation.
 *
 * Contact: Pekka Pessi <pekka.pessi@nokia.com>
 *
8
 * This library is free software; you can redistribute it and/or
Pekka Pessi's avatar
Pekka Pessi committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 * 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
 *
 */

Pekka Pessi's avatar
Pekka Pessi committed
25 26
#ifndef SIP_UTIL_H
/** Defined when <sofia-sip/sip_util.h> has been included. */
27
#define SIP_UTIL_H
Pekka Pessi's avatar
Pekka Pessi committed
28

29
/**@file sofia-sip/sip_util.h
Pekka Pessi's avatar
Pekka Pessi committed
30 31 32 33 34 35 36 37
 * @brief SIP utility functions
 *
 * @author Pekka Pessi <Pekka.Pessi@nokia.com>.
 *
 * @date Created: Thu Jun  8 19:28:55 2000 ppessi
 */

#ifndef SIP_H
38
#include <sofia-sip/sip.h>
Pekka Pessi's avatar
Pekka Pessi committed
39 40 41
#endif

#ifndef STRING0_H
42
#include <sofia-sip/string0.h>
Pekka Pessi's avatar
Pekka Pessi committed
43 44
#endif

Pekka Pessi's avatar
Pekka Pessi committed
45 46 47
#ifndef MSG_HEADER_H
#include <sofia-sip/msg_header.h>
#endif
48

Pekka Pessi's avatar
Pekka Pessi committed
49
SOFIA_BEGIN_DECLS
Pekka Pessi's avatar
Pekka Pessi committed
50 51

SOFIAPUBFUN
52
sip_contact_t *
53
sip_contact_create_from_via_with_transport(su_home_t *home,
54 55 56 57
					   sip_via_t const *v,
					   char const *user,
					   char const *transport);

Pekka Pessi's avatar
Pekka Pessi committed
58
SOFIAPUBFUN
Pekka Pessi's avatar
Pekka Pessi committed
59 60 61
sip_contact_t *sip_contact_create_from_via(su_home_t *, sip_via_t const *,
					   char const *user);

Pekka Pessi's avatar
Pekka Pessi committed
62
SOFIAPUBFUN
63 64 65 66 67 68
char *
sip_contact_string_from_via(su_home_t *home,
			    sip_via_t const *v,
			    char const *user,
			    char const *transport);

Pekka Pessi's avatar
Pekka Pessi committed
69
SOFIAPUBFUN int sip_transport_has_tls(char const *transport_name);
70

Pekka Pessi's avatar
Pekka Pessi committed
71 72 73
SOFIAPUBFUN int sip_response_terminates_dialog(int response_code,
					       sip_method_t method,
					       int *return_graceful_terminate);
Pekka Pessi's avatar
Pekka Pessi committed
74

Pekka Pessi's avatar
Pekka Pessi committed
75
SOFIAPUBFUN int sip_sanity_check(sip_t const *sip);
Pekka Pessi's avatar
Pekka Pessi committed
76

Pekka Pessi's avatar
Pekka Pessi committed
77
SOFIAPUBFUN unsigned sip_q_value(char const * q);
Pekka Pessi's avatar
Pekka Pessi committed
78

Pekka Pessi's avatar
Pekka Pessi committed
79
SOFIAPUBFUN url_t *sip_url_dup(su_home_t *sh, url_t const *o);
Pekka Pessi's avatar
Pekka Pessi committed
80

81
/**Add optional prefix and string to argument list if @a s is non-NULL.
Pekka Pessi's avatar
Pekka Pessi committed
82 83 84 85
 * @HIDE
 */
#define SIP_STRLOG(prefix, s) ((s) ? (prefix) : ""), ((s) ? (s) : "")

Pekka Pessi's avatar
Pekka Pessi committed
86
SOFIAPUBFUN int sip_addr_match(sip_addr_t const *a, sip_addr_t const *b);
Pekka Pessi's avatar
Pekka Pessi committed
87 88 89 90 91

/* ----------------------------------------------------------------------
 * Header-specific functions below
 */

Pekka Pessi's avatar
Pekka Pessi committed
92 93 94 95 96 97 98
SOFIAPUBFUN int sip_route_is_loose(sip_route_t const *r);
SOFIAPUBFUN sip_route_t *sip_route_remove(msg_t *msg, sip_t *sip);
SOFIAPUBFUN sip_route_t *sip_route_pop(msg_t *msg, sip_t *sip);
SOFIAPUBFUN sip_route_t *sip_route_follow(msg_t *msg, sip_t *sip);
SOFIAPUBFUN sip_route_t *sip_route_reverse(su_home_t *, sip_route_t const *);
SOFIAPUBFUN sip_route_t *sip_route_fixdup(su_home_t *, sip_route_t const *);
SOFIAPUBFUN sip_route_t *sip_route_fix(sip_route_t *route);
Pekka Pessi's avatar
Pekka Pessi committed
99

100
SOFIAPUBFUN sip_route_t *sip_route_fixdup_as(su_home_t *,
101
					     msg_hclass_t *,
102 103
					     sip_route_t const *);
SOFIAPUBFUN sip_route_t *sip_route_reverse_as(su_home_t *,
104
					     msg_hclass_t *,
105 106
					     sip_route_t const *);

Pekka Pessi's avatar
Pekka Pessi committed
107
SOFIAPUBFUN sip_via_t *sip_via_remove(msg_t *msg, sip_t *sip);
Pekka Pessi's avatar
Pekka Pessi committed
108

109 110 111
/* ---------------------------------------------------------------------- */
/* Caller preferences */

Pekka Pessi's avatar
Pekka Pessi committed
112
/** Check callerprefs. */
Pekka Pessi's avatar
Pekka Pessi committed
113
SOFIAPUBFUN int sip_prefs_matching(char const *pvalue,
114
				   char const *nvalue,
Pekka Pessi's avatar
Pekka Pessi committed
115 116
				   int *return_parse_error);
SOFIAPUBFUN int sip_is_callerpref(char const *param);
Pekka Pessi's avatar
Pekka Pessi committed
117 118

/** Type of the SIP media tag */
119 120
enum sp_type {
  sp_error = -1,
Pekka Pessi's avatar
Pekka Pessi committed
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
  sp_init,
  sp_literal,
  sp_string,
  sp_range,
};


/** Possible values for SIP media tags */
union sip_pref
{
  /** Type of the media tag */
  enum sp_type sp_type;

  /** Literal (tag="foo"). */
  struct sp_literal {
136
    enum sp_type spl_type;
Pekka Pessi's avatar
Pekka Pessi committed
137
    char const *spl_value;
138
    usize_t spl_length;
Pekka Pessi's avatar
Pekka Pessi committed
139 140
  } sp_literal;

141
  /** String (tag="&lt;foo&gt;"). */ /* (tag="<foo>") */
Pekka Pessi's avatar
Pekka Pessi committed
142 143 144
  struct sp_string {
    enum sp_type sps_type;
    char const *sps_value;
145
    usize_t sps_length;
Pekka Pessi's avatar
Pekka Pessi committed
146 147 148 149 150 151
  } sp_string;

  /** Numeric value or range (tag="#=1"; tag="#<=3"; tag="#>=-2"; tag="#1:6").
   */
  struct sp_range {
    enum sp_type spr_type;
152 153
    double spr_lower;		/**< Lower limit. Lowest value is -DBL_MAX. */
    double spr_upper;		/**< Upper limit. Highest value is DBL_MAX. */
Pekka Pessi's avatar
Pekka Pessi committed
154 155 156 157
  } sp_range;
};

/** Parse a single preference */
158 159
SOFIAPUBFUN int sip_prefs_parse(union sip_pref *sp,
				char const **in_out_s,
160
				int *return_negation);
Pekka Pessi's avatar
Pekka Pessi committed
161 162

/** Match preferences */
Pekka Pessi's avatar
Pekka Pessi committed
163 164 165 166 167 168 169 170 171 172
SOFIAPUBFUN int sip_prefs_match(union sip_pref const *, union sip_pref const *);

SOFIAPUBFUN int sip_contact_is_immune(sip_contact_t const *m);

/**@internal
 * Check if contact is immune to calleprefs.
 * @deprecated Use sip_contact_is_immune() instead.
 */
#define sip_contact_immune(m) sip_contact_is_immune(m)

173
SOFIAPUBFUN sip_contact_t *sip_contact_immunize(su_home_t *home,
Pekka Pessi's avatar
Pekka Pessi committed
174 175
						sip_contact_t const *m);

176
SOFIAPUBFUN int sip_contact_reject(sip_contact_t const *m,
Pekka Pessi's avatar
Pekka Pessi committed
177
				   sip_reject_contact_t const *rc);
Pekka Pessi's avatar
Pekka Pessi committed
178

179
SOFIAPUBFUN int sip_contact_accept(sip_contact_t const *m,
Pekka Pessi's avatar
Pekka Pessi committed
180 181 182 183
				   sip_accept_contact_t const *cp,
				   unsigned *return_S,
				   unsigned *return_N,
				   int *return_error);
Pekka Pessi's avatar
Pekka Pessi committed
184

Pekka Pessi's avatar
Pekka Pessi committed
185 186 187
SOFIAPUBFUN int sip_contact_score(sip_contact_t const *m,
				  sip_accept_contact_t const *ac,
				  sip_reject_contact_t const *rc);
Pekka Pessi's avatar
Pekka Pessi committed
188 189


Pekka Pessi's avatar
Pekka Pessi committed
190
SOFIAPUBFUN int sip_aor_strip(url_t *url);
Pekka Pessi's avatar
Pekka Pessi committed
191

Pekka Pessi's avatar
Pekka Pessi committed
192
/* sec-agree utility functions. */
Pekka Pessi's avatar
Pekka Pessi committed
193

Pekka Pessi's avatar
Pekka Pessi committed
194 195 196
SOFIAPUBFUN int sip_security_verify_compare(sip_security_server_t const *s,
					    sip_security_verify_t const *v,
					    char const **return_d_ver);
Pekka Pessi's avatar
Pekka Pessi committed
197

198
SOFIAPUBFUN
199 200 201 202
sip_security_client_t const *
sip_security_client_select(sip_security_client_t const *client,
			   sip_security_server_t const *server);

Pekka Pessi's avatar
Pekka Pessi committed
203 204 205 206 207 208 209
/* Compatibility stuff */

#define sip_params_add      	msg_params_add
#define sip_params_cmp      	msg_params_cmp
#define sip_params_replace  	msg_params_replace
#define sip_params_find         msg_params_find

210 211
SOFIA_END_DECLS

Pekka Pessi's avatar
Pekka Pessi committed
212
#endif /** !defined(SIP_UTIL_H) */