Modifying the return value of cfg_set* functions, in order to make
[sip-router] / usr_avp.h
1 /*
2  * $Id$
3  *
4  * Copyright (C) 2001-2003 FhG Fokus
5  *
6  * This file is part of ser, a free SIP server.
7  *
8  * ser is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version
12  *
13  * For a license to use the ser software under conditions
14  * other than those described here, or to purchase support for this
15  * software, please contact iptel.org by e-mail at the following addresses:
16  *    info@iptel.org
17  *
18  * ser is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26  *
27  * History:
28  * ---------
29  *  2004-07-21  created (bogdan)
30  *  2004-11-14  global aliases support added
31  *  2005-02-14  list with FLAGS USAGE added (bogdan)
32  */
33
34 #ifndef _SER_USR_AVP_H_
35 #define _SER_USR_AVP_H_
36
37 #include <sys/types.h>
38 #include <regex.h>
39
40
41 /*
42  *   LIST with the allocated flags, their meaning and owner
43  *   flag no.    owner            description
44  *   -------------------------------------------------------
45  *     0        avp_core          avp has a string name
46  *     1        avp_core          avp has a string value
47  *     2        avp_core          regex search in progress
48  *     3        avpops module     avp was loaded from DB
49  *     4        lcr module        contact avp qvalue change
50  *     5        core              avp is in user list
51  *     6        core              avp is in domain list
52  *     7        core              avp is in global list
53  *     8        core              avp is in the from avp list
54  *     9        core              avp is in the to avp list
55  *    10        core              avp name with positive index
56  *    11        core              avp name with negative index
57  */
58
59 #include "str.h"
60
61
62 #define AVP_UID          "uid"           /* Unique user identifier */
63 #define AVP_DID          "did"           /* Unique domain identifier */
64 #define AVP_REALM        "digest_realm"  /* Digest realm */
65 #define AVP_FR_TIMER     "fr_timer"      /* Value of final response timer */
66 #define AVP_FR_INV_TIMER "fr_inv_timer"  /* Value of final response invite timer */
67 #define AVP_RPID         "rpid"          /* Remote-Party-ID */
68 #define AVP_GFLAGS       "gflags"        /* global flags */
69
70 struct str_int_data {
71         str name;
72         int val;
73 };
74
75 struct str_str_data {
76         str name;
77         str val;
78 };
79
80 typedef union {
81         int  n;
82         str  s;
83         regex_t* re;
84 } int_str;
85
86 #define avp_id_t        unsigned short
87 #define avp_flags_t     unsigned int
88 #define avp_name_t      int_str
89 #define avp_value_t     int_str
90 #define avp_index_t     unsigned short
91
92 typedef struct usr_avp {
93         avp_id_t id;
94              /* Flags that are kept for the AVP lifetime */
95         avp_flags_t flags;
96         struct usr_avp *next;
97         void *data;
98 } avp_t;
99
100 typedef avp_t* avp_list_t;
101
102 /* AVP identification */
103 typedef struct avp_ident {
104         avp_flags_t flags;
105         avp_name_t name;
106         avp_index_t index;
107 } avp_ident_t;
108
109 /*
110  * AVP search state
111  */
112 struct search_state {
113         avp_flags_t flags;  /* Type of search and additional flags */
114         avp_id_t id;
115         avp_name_t name;
116         avp_t* avp;            /* Current AVP */
117 //      regex_t* search_re;    /* Compiled regular expression */
118 };
119
120 /* avp aliases structs*/
121 typedef struct avp_spec {
122         avp_flags_t type;
123         avp_name_t name;
124         avp_index_t index;
125 } avp_spec_t;
126
127 /* AVP types */
128 #define AVP_NAME_STR     (1<<0)
129 #define AVP_VAL_STR      (1<<1)
130 #define AVP_NAME_RE      (1<<2)
131
132 /* AVP classes */
133 #define AVP_CLASS_URI    (1<<4)
134 #define AVP_CLASS_USER   (1<<5)
135 #define AVP_CLASS_DOMAIN (1<<6)
136 #define AVP_CLASS_GLOBAL (1<<7)
137
138 /* AVP track (either from or to) */
139 #define AVP_TRACK_FROM   (1<<8)
140 #define AVP_TRACK_TO     (1<<9)
141 #define AVP_TRACK_ALL    (AVP_TRACK_FROM|AVP_TRACK_TO)
142
143 #define AVP_CLASS_ALL (AVP_CLASS_URI|AVP_CLASS_USER|AVP_CLASS_DOMAIN|AVP_CLASS_GLOBAL)
144
145 /* AVP name index */
146 #define AVP_INDEX_FORWARD       (1<<10)
147 #define AVP_INDEX_BACKWARD      (1<<11)
148 #define AVP_INDEX_ALL           (AVP_INDEX_FORWARD | AVP_INDEX_BACKWARD)
149
150 #define AVP_CUSTOM_FLAGS        12
151
152 #define GALIAS_CHAR_MARKER  '$'
153
154 #define AVP_IS_ASSIGNABLE(ident) ( ((ident).flags & AVP_NAME_RE) == 0 && (((ident).flags & AVP_NAME) == 0 || (((ident)->flags & AVP_NAME) && (ident).name.s.len)) )
155 /* Initialize memory structures */
156 int init_avps(void);
157
158 /* add avp to the list of avps */
159 int add_avp(avp_flags_t flags, avp_name_t name, avp_value_t val);
160 int add_avp_before(avp_t *avp, avp_flags_t flags, avp_name_t name, avp_value_t val);
161 int add_avp_list(avp_list_t* list, avp_flags_t flags, avp_name_t name, avp_value_t val);
162
163 /* Delete avps with given type and name */
164 void delete_avp(avp_flags_t flags, avp_name_t name);
165
166 /* search functions */
167 avp_t *search_first_avp( avp_flags_t flags, avp_name_t name,
168                          avp_value_t *val, struct search_state* state);
169 avp_t *search_avp_by_index( avp_flags_t flags, avp_name_t name,
170                             avp_value_t *val, avp_index_t index);
171
172 avp_t *search_avp (avp_ident_t ident, avp_value_t* val, struct search_state* state);
173 avp_t *search_next_avp(struct search_state* state, avp_value_t *val);
174
175 /* Reset one avp list */
176 int reset_avp_list(int flags);
177
178 /* free functions */
179 void reset_avps(void);
180
181 void destroy_avp(avp_t *avp);
182 void destroy_avp_list(avp_list_t *list );
183 void destroy_avp_list_unsafe(avp_list_t *list );
184
185 /* get func */
186 void get_avp_val(avp_t *avp, avp_value_t *val );
187 str* get_avp_name(avp_t *avp);
188
189 avp_list_t get_avp_list(avp_flags_t flags);
190 avp_list_t* set_avp_list(avp_flags_t flags, avp_list_t* list);
191
192
193 /* global alias functions (manipulation and parsing)*/
194 int add_avp_galias_str(char *alias_definition);
195 int lookup_avp_galias(str *alias, int *type, int_str *avp_name);
196 int add_avp_galias(str *alias, int type, int_str avp_name);
197 int parse_avp_ident( str *name, avp_ident_t* attr);
198 int parse_avp_name( str *name, int *type, int_str *avp_name, int *index);
199 int parse_avp_spec( str *name, int *type, int_str *avp_name, int *index);
200 void free_avp_name( int *type, int_str *avp_name);
201
202 /* AVP flags functions */
203 #define MAX_AVPFLAG  ((unsigned int)( sizeof(avp_flags_t) * CHAR_BIT - 1 - AVP_CUSTOM_FLAGS))
204
205 avp_flags_t register_avpflag(char* name);
206 avp_flags_t get_avpflag_no(char* name);
207
208 #endif