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