- rewritten module function parsing and call processing (mk_action, struct action...
[sip-router] / route_struct.h
1 /*
2  * $Id$
3  *
4  *
5  * Copyright (C) 2001-2003 FhG Fokus
6  *
7  * This file is part of ser, a free SIP server.
8  *
9  * ser is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version
13  *
14  * For a license to use the ser software under conditions
15  * other than those described here, or to purchase support for this
16  * software, please contact iptel.org by e-mail at the following addresses:
17  *    info@iptel.org
18  *
19  * ser is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License
25  * along with this program; if not, write to the Free Software
26  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
27  */
28 /* History:
29  * --------
30  *
31  *  2003-04-12  FORCE_RPORT_T added (andrei)
32  *  2003-04-22  strip_tail added (jiri)
33  *  2003-10-10  >,<,>=,<=, != and MSGLEN_O added (andrei)
34  *  2003-10-28  FORCE_TCP_ALIAS added (andrei)
35  *  2004-02-24  added LOAD_AVP_T and AVP_TO_URI_T (bogdan)
36  *  2005-12-11  added SND{IP,PORT,PROTO,AF}_O & TO{IP,PORT}_O (andrei)
37  *  2005-12-19  select framework added SELECT_O and SELECT_ST (mma)
38  */
39
40
41 #ifndef route_struct_h
42 #define route_struct_h
43
44 #include <regex.h>
45 #include "select.h"
46 #include "usr_avp.h"
47
48 #define EXPR_DROP -127  /* used only by the expression and if evaluator */
49 /*
50  * Other important values (no macros for them yet):
51  * expr true = 1
52  * expr false = 0 (used only inside the expression and if evaluator)
53  *
54  * action continue  or if used in condition true = 1
55  * action drop/quit/stop script processing = 0
56  * action error or if used in condition false = -1 (<0 and !=EXPR_DROP)
57  *
58  */
59
60
61 enum { EXP_T=1, ELEM_T };
62 enum { LOGAND_OP=1, LOGOR_OP, NOT_OP, BINAND_OP, BINOR_OP };
63 enum { EQUAL_OP=10, MATCH_OP, GT_OP, LT_OP, GTE_OP, LTE_OP, DIFF_OP, NO_OP };
64 enum { METHOD_O=1, URI_O, FROM_URI_O, TO_URI_O, SRCIP_O, SRCPORT_O,
65            DSTIP_O, DSTPORT_O, PROTO_O, AF_O, MSGLEN_O, DEFAULT_O, ACTION_O,
66            NUMBER_O, AVP_O, SNDIP_O, SNDPORT_O, TOIP_O, TOPORT_O, SNDPROTO_O,
67            SNDAF_O, RETCODE_O, SELECT_O};
68
69 enum { FORWARD_T=1, SEND_T, DROP_T, LOG_T, ERROR_T, ROUTE_T, EXEC_T,
70                 SET_HOST_T, SET_HOSTPORT_T, SET_USER_T, SET_USERPASS_T,
71                 SET_PORT_T, SET_URI_T, IF_T, MODULE_T,
72                 SETFLAG_T, RESETFLAG_T, ISFLAGSET_T ,
73                 LEN_GT_T, PREFIX_T, STRIP_T,STRIP_TAIL_T,
74                 APPEND_BRANCH_T,
75                 REVERT_URI_T,
76                 FORWARD_TCP_T,
77                 FORWARD_UDP_T,
78                 FORWARD_TLS_T,
79                 SEND_TCP_T,
80                 FORCE_RPORT_T,
81                 SET_ADV_ADDR_T,
82                 SET_ADV_PORT_T,
83                 FORCE_TCP_ALIAS_T,
84                 LOAD_AVP_T,
85                 AVP_TO_URI_T,
86                 FORCE_SEND_SOCKET_T,
87                 ASSIGN_T,
88                 ADD_T
89
90 };
91 enum { NOSUBTYPE=0, STRING_ST, NET_ST, NUMBER_ST, IP_ST, RE_ST, PROXY_ST,
92                 EXPR_ST, ACTIONS_ST, MODEXP_ST, MODFIXUP_ST, URIHOST_ST, URIPORT_ST,
93                 MYSELF_ST, STR_ST, SOCKID_ST, SOCKETINFO_ST, ACTION_ST, AVP_ST, SELECT_ST,
94                 RETCODE_ST};
95
96 /* run flags */
97 #define EXIT_R_F   1
98 #define RETURN_R_F 2
99
100 /* Expression operand */
101 union exp_op {
102         struct expr* expr;
103         str str;
104         char* string;
105         void* param;
106         int intval;
107         avp_spec_t* attr;
108         select_t* select;
109         regex_t* re;
110         struct net* net;
111 };
112
113 struct expr{
114         int type; /* exp, exp_elem */
115         int op; /* and, or, not | ==,  =~ */
116         int l_type, r_type;
117         union exp_op l;
118         union exp_op r;
119 };
120
121 typedef struct {
122         int type;
123         union {
124                 long number;
125                 char* string;
126                 str str;
127                 void* data;
128                 avp_spec_t* attr;
129                 select_t* select;
130         } u;
131 } action_u_t;
132
133 #define MAX_ACTIONS 4
134
135 struct action{
136         int type;  /* forward, drop, log, send ...*/
137         int count;
138         action_u_t val[MAX_ACTIONS];
139         struct action* next;
140 };
141
142 struct expr* mk_exp(int op, struct expr* left, struct expr* right);
143 struct expr* mk_elem(int op, int ltype, void* lparam, int rtype, void* rparam);
144
145 struct action* mk_action(int type, int count/* of couples {type,val} */, .../* int type1, void *val1 [, int type2, void *val2, ...] */);
146 struct action* append_action(struct action* a, struct action* b);
147
148 void print_action(struct action* a);
149 void print_actions(struct action* a);
150 void print_expr(struct expr* exp);
151
152 #endif
153