1 /*****************************************************************************\
5 **---------------------------------------------------------------------------**
6 ** Copyright: Andreas Eversberg **
8 ** match header file **
10 \*****************************************************************************/
13 /* memory structure of rulesets */
15 enum { /* value types */
18 VALUE_TYPE_INTEGER_RANGE,
20 VALUE_TYPE_STRING_RANGE,
23 enum { /* how to parse text file during startup */
38 enum { /* what to check during runtime */
80 enum { /* how to parse text file during startup */
85 PARAM_TYPE_CAPABILITY,
91 PARAM_TYPE_CALLERIDTYPE,
95 enum { /* defines when a statement should be executed */
100 /* parameter ID bits */
101 #define PARAM_PROCEEDING 1LL
102 #define PARAM_ALERTING (1LL<<1)
103 #define PARAM_CONNECT (1LL<<2)
104 #define PARAM_EXTENSION (1LL<<3)
105 #define PARAM_EXTENSIONS (1LL<<4)
106 #define PARAM_PREFIX (1LL<<5)
107 #define PARAM_CAPA (1LL<<6)
108 #define PARAM_BMODE (1LL<<7)
109 #define PARAM_INFO1 (1LL<<8)
110 #define PARAM_HLC (1LL<<9)
111 #define PARAM_EXTHLC (1LL<<10)
112 #define PARAM_PRESENT (1LL<<11)
113 #define PARAM_DIVERSION (1LL<<12)
114 #define PARAM_DEST (1LL<<13)
115 #define PARAM_SELECT (1LL<<14)
116 #define PARAM_DELAY (1LL<<15)
117 #define PARAM_LIMIT (1LL<<16)
118 #define PARAM_HOST (1LL<<17)
119 #define PARAM_PORT (1LL<<18)
120 #define PARAM_INTERFACES (1LL<<19)
121 #define PARAM_ADDRESS (1LL<<20)
122 #define PARAM_SAMPLE (1LL<<21)
123 #define PARAM_ANNOUNCEMENT (1LL<<22)
124 #define PARAM_RULESET (1LL<<23)
125 #define PARAM_CAUSE (1LL<<24)
126 #define PARAM_LOCATION (1LL<<25)
127 #define PARAM_DISPLAY (1LL<<26)
128 #define PARAM_PORTS (1LL<<27)
129 #define PARAM_TPRESET (1LL<<28)
130 #define PARAM_FILE (1LL<<29)
131 #define PARAM_CONTENT (1LL<<30)
132 #define PARAM_APPEND (1LL<<31)
133 #define PARAM_EXECUTE (1LL<<32)
134 #define PARAM_PARAM (1LL<<33)
135 #define PARAM_TYPE (1LL<<34)
136 #define PARAM_COMPLETE (1LL<<35)
137 #define PARAM_CALLERID (1LL<<36)
138 #define PARAM_CALLERIDTYPE (1LL<<37)
139 #define PARAM_CALLTO (1LL<<38)
140 #define PARAM_ROOM (1LL<<39)
141 #define PARAM_JINGLE (1LL<<40)
142 #define PARAM_TIMEOUT (1LL<<41)
143 #define PARAM_NOPASSWORD (1LL<<42)
144 #define PARAM_STRIP (1LL<<43)
145 #define PARAM_APPLICATION (1LL<<44)
146 #define PARAM_CONTEXT (1LL<<45)
147 #define PARAM_EXTEN (1LL<<46)
148 #define PARAM_ON (1LL<<47)
149 #define PARAM_KEYPAD (1LL<<48)
152 * NOTE: The given index is the actual entry number of action_defs[], so add/remove both lists!!!
154 #define ACTION_EXTERNAL 0
155 #define ACTION_INTERNAL 1
156 #define ACTION_OUTDIAL 2
157 #define ACTION_REMOTE 3
158 #define ACTION_VBOX_RECORD 4
159 #define ACTION_PARTYLINE 5
160 #define ACTION_LOGIN 6
161 #define ACTION_CALLERID 7
162 #define ACTION_CALLERIDNEXT 8
163 #define ACTION_FORWARD 9
164 #define ACTION_REDIAL 10
165 #define ACTION_REPLY 11
166 #define ACTION_POWERDIAL 12
167 #define ACTION_CALLBACK 13
168 #define ACTION_ABBREV 14
169 #define ACTION_TEST 15
170 #define ACTION_PLAY 16
171 #define ACTION_VBOX_PLAY 17
172 #define ACTION_CALCULATOR 18
173 #define ACTION_TIMER 19
174 #define ACTION_GOTO 20
175 #define ACTION_MENU 21
176 #define ACTION_DISCONNECT 22
177 #define ACTION_RELEASE 23
178 #define ACTION_DEFLECT 24
179 #define ACTION_SETFORWARD 25
180 #define ACTION_EXECUTE 26
181 #define ACTION_FILE 27
182 #define ACTION_PICK 28
183 #define ACTION_PASSWORD 29
184 #define ACTION_PASSWORD_WRITE 30
185 #define ACTION_NOTHING 31
186 #define ACTION_EFI 32
188 struct route_cond { /* an item */
189 struct route_cond *next; /* next entry */
190 int index; /* index of cond_defs */
191 int match; /* what is matching (MATCH_*) */
192 int value_type; /* type of value (VALUE_TYPE_*) */
193 int value_extension; /* will it be extended? */
194 int integer_value; /* first integer */
195 int integer_value_to; /* second integer */
196 char *string_value; /* first string */
197 char *string_value_to; /* second string */
198 int comp_string; /* compare value of strings */
201 struct route_param { /* a parameter */
202 struct route_param *next; /* next item */
203 int index; /* index of param_defs */
204 unsigned long long id; /* what is it (PARAM_*) */
205 int value_type; /* type of value (VALUE_TYPE_*) */
206 int value_extension; /* will it be extended? */
207 int integer_value; /* integer value */
208 char *string_value; /* string value */
211 struct route_action { /* an action has a list of parameters */
212 struct route_action *next; /* next item */
213 struct route_param *param_first; /* link to parameter list */
214 int index; /* index of action_defs */
215 int timeout; /* timeout value for action (0 = no timeout) */
216 int line; /* line parsed from */
219 struct route_rule { /* a rule has a list of items and actions */
220 struct route_rule *next; /* next item */
221 char file[128]; /* filename */
222 int line; /* line parsed from */
223 struct route_cond *cond_first; /* link to condition list */
224 struct route_action *action_first; /* link to action list */
225 // int temp_couldmatch; /* stores, if the dialing could match. this is used to make a list of rules, that could match */
228 struct route_ruleset { /* the ruleset is a list of rules */
229 struct route_ruleset *next; /* next item */
230 char file[128]; /* filename */
231 int line; /* line parsed from */
232 char name[64]; /* name of ruleset */
233 struct route_rule *rule_first; /* linke to rule list */
236 struct cond_defs { /* defintion of all conditions */
237 const char *name; /* item's name */
238 int match; /* what to check */
239 int type; /* type of value (COND_TYPE) */
240 const char *doc; /* syntax */
241 const char *help; /* short help */
244 struct param_defs { /* definition of all options */
245 unsigned long long id; /* ID of parameter (just for checking) */
246 const char *name; /* name of parameter */
247 int type; /* type of value (PARAM_TYPE_*) */
248 const char *doc; /* syntax */
249 const char *help; /* quick help */
252 struct action_defs { /* definition of all actions */
253 int id; /* ID of parameter (just for checking) */
255 void (EndpointAppPBX::*init_func)(void);
256 void (EndpointAppPBX::*dialing_func)(void);
257 void (EndpointAppPBX::*hangup_func)(void);
258 unsigned long long params;
264 extern struct cond_defs cond_defs[];
265 extern struct param_defs param_defs[];
266 extern struct action_defs action_defs[];
267 extern struct route_ruleset *ruleset_first;
268 extern struct route_ruleset *ruleset_main;
269 extern struct route_action action_external;
270 extern struct route_action action_internal;
271 extern struct route_action action_remote;
272 extern struct route_action action_vbox;
273 extern struct route_action action_partyline;
274 extern struct route_action action_password;
275 extern struct route_action action_password_write;
276 extern struct route_action action_disconnect;
280 void doc_rules(const char *action);
281 void ruleset_free(struct route_ruleset *ruleset_start);
282 void ruleset_debug(struct route_ruleset *ruleset_start);
283 extern char ruleset_error[256];
284 struct route_ruleset *ruleset_parse(void);
285 struct route_ruleset *getrulesetbyname(const char *name);