core: Make sure that responses to requests received on a WebSocket are sent on existi...
[sip-router] / pvar.h
1 /*
2  * $Id: items.h 2111 2007-05-01 11:18:08Z juhe $
3  *
4  * Copyright (C) 2001-2003 FhG Fokus
5  *
6  * This file is part of SIP-Router, a free SIP server.
7  *
8  * SIP-Router 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  * SIP-Router is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License 
19  * along with this program; if not, write to the Free Software 
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  */
22
23 /*!
24  * \file
25  * \brief Definitions for Pseudo-variable support
26  */
27
28
29 #ifndef _PVAR_H_
30 #define _PVAR_H_
31
32 #include "str.h"
33 #include "usr_avp.h"
34 #include "parser/msg_parser.h"
35
36 #define PV_MARKER_STR   "$"
37 #define PV_MARKER               '$'
38
39 #define PV_LNBRACKET_STR        "("
40 #define PV_LNBRACKET            '('
41 #define PV_RNBRACKET_STR        ")"
42 #define PV_RNBRACKET            ')'
43
44 #define PV_LIBRACKET_STR        "["
45 #define PV_LIBRACKET            '['
46 #define PV_RIBRACKET_STR        "]"
47 #define PV_RIBRACKET            ']'
48
49 #define PV_VAL_NONE                     0
50 #define PV_VAL_NULL                     1
51 #define PV_VAL_EMPTY            2
52 #define PV_VAL_STR                      4
53 #define PV_VAL_INT                      8
54 #define PV_TYPE_INT                     16
55 #define PV_VAL_PKG                      32
56 #define PV_VAL_SHM                      64
57
58 #define PV_NAME_INTSTR  0
59 #define PV_NAME_PVAR    1
60 #define PV_NAME_OTHER   2
61
62 #define PV_IDX_INT      0
63 #define PV_IDX_PVAR     1
64 #define PV_IDX_ALL      2
65
66 /*! if PV name is dynamic, integer, or str */
67 #define pv_has_dname(pv) ((pv)->pvp.pvn.type==PV_NAME_PVAR)
68 #define pv_has_iname(pv) ((pv)->pvp.pvn.type==PV_NAME_INTSTR \
69                                                         && !((pv)->pvp.pvn.u.isname.type&AVP_NAME_STR))
70 #define pv_has_sname(pv) ((pv)->pvp.pvn.type==PV_NAME_INTSTR \
71                                                         && (pv)->pvp.pvn.u.isname.type&AVP_NAME_STR)
72 #define pv_is_w(pv)     ((pv)->setf!=NULL)
73
74 enum _pv_type { 
75         PVT_NONE=0,           PVT_EMPTY,             PVT_NULL, 
76         PVT_MARKER,           PVT_AVP,               PVT_HDR,
77         PVT_RURI,             PVT_RURI_USERNAME,     PVT_RURI_DOMAIN,
78         PVT_DSTURI,           PVT_COLOR,             PVT_BRANCH,
79         PVT_FROM,             PVT_TO,                PVT_OURI,
80         PVT_SCRIPTVAR,        PVT_MSG_BODY,          PVT_CONTEXT,
81         PVT_OTHER,            PVT_EXTRA /* keep it last */
82 };
83
84 typedef enum _pv_type pv_type_t;
85 typedef int pv_flags_t;
86
87 typedef void (*pv_name_free_f)(void*);
88
89 typedef struct _pv_value
90 {
91         str rs;    /*!< string value */
92         int ri;    /*!< integer value */
93         int flags; /*!< flags about the type of value */
94 } pv_value_t, *pv_value_p;
95
96 typedef struct _pv_name
97 {
98         int type;             /*!< type of name */
99         pv_name_free_f nfree; /*!< function to free name structure */
100         union {
101                 struct {
102                         int type;     /*!< type of int_str name - compatibility with AVPs */
103                         int_str name; /*!< the value of the name */
104                 } isname;
105                 void *dname;      /*!< PV value - dynamic name */
106         } u;
107 } pv_name_t, *pv_name_p;
108
109 typedef struct _pv_index
110 {
111         int type; /*!< type of PV index */
112         union {
113                 int ival;   /*!< integer value */
114                 void *dval; /*!< PV value - dynamic index */
115         } u;
116 } pv_index_t, *pv_index_p;
117
118 typedef struct _pv_param
119 {
120         pv_name_t    pvn; /*!< PV name */
121         pv_index_t   pvi; /*!< PV index */
122 } pv_param_t, *pv_param_p;
123
124 typedef int (*pv_getf_t) (struct sip_msg*,  pv_param_t*, pv_value_t*);
125 typedef int (*pv_setf_t) (struct sip_msg*,  pv_param_t*, int, pv_value_t*);
126
127 typedef struct _pv_spec {
128         pv_type_t    type;   /*!< type of PV */
129         pv_getf_t    getf;   /*!< get PV value function */
130         pv_setf_t    setf;   /*!< set PV value function */
131         pv_param_t   pvp;    /*!< parameter to be given to get/set functions */
132         void         *trans; /*!< transformations */
133 } pv_spec_t, *pv_spec_p;
134
135 typedef int (*pv_parse_name_f)(pv_spec_p sp, str *in);
136 typedef int (*pv_parse_index_f)(pv_spec_p sp, str *in);
137 typedef int (*pv_init_param_f)(pv_spec_p sp, int param);
138
139 #define pv_alter_context(pv)    ((pv)->type==PVT_CONTEXT \
140                                                                         || (pv)->type==PVT_BRANCH)
141
142 /*! \brief
143  * PV spec format:
144  * - $class_name
145  * - $class_name(inner_name)
146  * - $(class_name[index])
147  * - $(class_name(inner_name)[index])
148  * - $(class_name{transformation})
149  * - $(class_name(inner_name){transformation})
150  * - $(class_name[index]{transformation})
151  * - $(class_name(inner_name)[index]{transformation})
152  */
153 typedef struct _pv_export {
154         str name;                      /*!< class name of PV */
155         pv_type_t type;                /*!< type of PV */
156         pv_getf_t  getf;               /*!< function to get the value */
157         pv_setf_t  setf;               /*!< function to set the value */
158         pv_parse_name_f parse_name;    /*!< function to parse the inner name */
159         pv_parse_index_f parse_index;  /*!< function to parse the index of PV */
160         pv_init_param_f init_param;    /*!< function to init the PV spec */
161         int iparam;                    /*!< parameter for the init function */
162 } pv_export_t;
163
164 typedef struct _pv_elem
165 {
166         str text;
167         pv_spec_t spec;
168         struct _pv_elem *next;
169 } pv_elem_t, *pv_elem_p;
170
171 char* pv_parse_spec2(str *in, pv_spec_p sp, int silent);
172 #define pv_parse_spec(in, sp) pv_parse_spec2((in), (sp), 0)
173 int pv_get_spec_value(struct sip_msg* msg, pv_spec_p sp, pv_value_t *value);
174 int pv_set_spec_value(struct sip_msg* msg, pv_spec_p sp, int op,
175                 pv_value_t *value);
176 int pv_printf(struct sip_msg* msg, pv_elem_p list, char *buf, int *len);
177 int pv_elem_free_all(pv_elem_p log);
178 void pv_value_destroy(pv_value_t *val);
179 void pv_spec_destroy(pv_spec_t *spec);
180 void pv_spec_free(pv_spec_t *spec);
181 int pv_spec_dbg(pv_spec_p sp);
182 int pv_get_spec_index(struct sip_msg* msg, pv_param_p ip, int *idx, int *flags);
183 int pv_get_avp_name(struct sip_msg* msg, pv_param_p ip, int_str *avp_name,
184                 unsigned short *name_type);
185 int pv_parse_avp_name(pv_spec_p sp, str *in);
186 int pv_get_spec_name(struct sip_msg* msg, pv_param_p ip, pv_value_t *name);
187 int pv_parse_format(str *in, pv_elem_p *el);
188 int pv_parse_index(pv_spec_p sp, str *in);
189 int pv_init_iname(pv_spec_p sp, int param);
190 int pv_printf_s(struct sip_msg* msg, pv_elem_p list, str *s);
191
192 typedef struct _pvname_list {
193         pv_spec_t sname;
194         struct _pvname_list *next;
195 } pvname_list_t, *pvname_list_p;
196
197 typedef struct pv_spec_list {
198         pv_spec_p spec;
199         struct pv_spec_list *next;
200 } pv_spec_list_t, *pv_spec_list_p;
201
202 pvname_list_t* parse_pvname_list(str *in, unsigned int type);
203
204 int register_pvars_mod(char *mod_name, pv_export_t *items);
205 int pv_free_extra_list(void);
206
207 int pv_locate_name(str *in);
208 pv_spec_t* pv_cache_get(str *name);
209
210 /*! \brief PV helper functions */
211 int pv_get_null(struct sip_msg *msg, pv_param_t *param, pv_value_t *res);
212
213 int pv_get_uintval(struct sip_msg *msg, pv_param_t *param,
214                 pv_value_t *res, unsigned int uival);
215 int pv_get_sintval(struct sip_msg *msg, pv_param_t *param,
216                 pv_value_t *res, int sival);
217 int pv_get_strval(struct sip_msg *msg, pv_param_t *param,
218                 pv_value_t *res, str *sval);
219 int pv_get_strintval(struct sip_msg *msg, pv_param_t *param,
220                 pv_value_t *res, str *sval, int ival);
221 int pv_get_intstrval(struct sip_msg *msg, pv_param_t *param,
222                 pv_value_t *res, int ival, str *sval);
223
224 /**
225  * Transformations
226  */
227 #define TR_LBRACKET_STR         "{"
228 #define TR_LBRACKET             '{'
229 #define TR_RBRACKET_STR         "}"
230 #define TR_RBRACKET             '}'
231 #define TR_CLASS_MARKER         '.'
232 #define TR_PARAM_MARKER         ','
233
234 enum _tr_param_type { TR_PARAM_NONE=0, TR_PARAM_STRING, TR_PARAM_NUMBER,
235         TR_PARAM_SPEC, TR_PARAM_SUBST, TR_PARAM_OTHER };
236
237 typedef struct _tr_param {
238         int type;
239         union {
240                 int n;
241                 str s;
242                 void *data;
243         } v;
244         struct _tr_param *next;
245 } tr_param_t, *tr_param_p;
246
247 typedef int (*tr_func_t) (struct sip_msg *, tr_param_t*, int, pv_value_t*);
248
249 typedef struct _trans {
250         str name;
251         int type;
252         int subtype;
253         tr_func_t trf;
254         tr_param_t *params;
255         struct _trans *next;
256 } trans_t, *trans_p;
257
258 typedef char* (*tr_parsef_t)(str *, trans_t *);
259 typedef struct _tr_export {
260         str tclass;
261         tr_parsef_t tparse; 
262 } tr_export_t, *tr_export_p;
263
264 char* tr_lookup(str *in, trans_t **tr);
265 tr_export_t* tr_lookup_class(str *tclass);
266 int tr_exec(struct sip_msg *msg, trans_t *t, pv_value_t *v);
267 void tr_param_free(tr_param_t *tp);
268
269 int register_trans_mod(char *mod_name, tr_export_t *items);
270
271 #endif
272