1 /*****************************************************************************\
5 **---------------------------------------------------------------------------**
6 ** Copyright: Andreas Eversberg **
8 ** match processing of routing configuration **
10 \*****************************************************************************/
15 struct route_ruleset *ruleset_first; /* first entry */
16 struct route_ruleset *ruleset_main; /* pointer to main ruleset */
18 struct cond_defs cond_defs[] = {
19 { "extern", MATCH_EXTERN, COND_TYPE_NULL,
20 "extern", "Matches if call is from external port (no extension)."},
21 { "intern", MATCH_INTERN,COND_TYPE_NULL,
22 "intern", "Matches if call is from an extension."},
23 { "port", MATCH_PORT, COND_TYPE_INTEGER,
24 "port=<number>[-<number>][,...]", "Matches if call is received from given port(s). NOT INTERFACE!"},
25 { "interface", MATCH_INTERFACE,COND_TYPE_STRING,
26 "interface=<interface>[,...]", "Matches if call is received from given interface(s). NOT PORTS!"},
27 { "callerid", MATCH_CALLERID, COND_TYPE_STRING,
28 "callerid=<digits>[-<digits>][,...]", "Matches if caller ID matches or begins with the given (range(s) of) prefixes(s)."},
29 { "callerid2", MATCH_CALLERID2,COND_TYPE_STRING,
30 "callerid2=<digits>[-<digits>][,...]", "Matches the second caller ID (network provided)."},
31 { "extension", MATCH_EXTENSION,COND_TYPE_STRING,
32 "extension=<digits>[-<digits>][,...]", "Matches if caller calls from given (range(s) of) extension(s)."},
33 { "dialing", MATCH_DIALING, COND_TYPE_STRING,
34 "dialing=<digits>[-<digits>][,...]", "Matches if caller has dialed the given (range(s) of) digits at least."},
35 { "enblock", MATCH_ENBLOCK, COND_TYPE_NULL,
36 "enblock", "Matches if caller dialed en block. (Dial the number before pick up.)"},
37 { "overlap", MATCH_OVERLAP, COND_TYPE_NULL,
38 "overlap", "Matches if caller dialed digit by digit. (Dial the number after pick up.)"},
39 { "anonymous", MATCH_ANONYMOUS,COND_TYPE_NULL,
40 "anonymous", "Matches if caller uses restricted caller ID or if not available."},
41 { "visible", MATCH_VISIBLE, COND_TYPE_NULL,
42 "visible", "Matches if caller ID is presented and if available."},
43 { "unknown", MATCH_UNKNOWN, COND_TYPE_NULL,
44 "unknown", "Matches if no ID is available from caller."},
45 { "available", MATCH_AVAILABLE,COND_TYPE_NULL,
46 "available", "Matches if ID is available from caller."},
47 { "fake", MATCH_FAKE, COND_TYPE_NULL,
48 "fake", "Matches if caller ID is not screened and may be faked by caller."},
49 { "real", MATCH_REAL, COND_TYPE_NULL,
50 "real", "Matches if caller ID is screend and so it is the real caller's ID."},
51 { "redirected", MATCH_REDIRECTED,COND_TYPE_NULL,
52 "redirected", "Matches if caller has been redirected."},
53 { "direct", MATCH_DIRECT ,COND_TYPE_NULL,
54 "direct", "Matches if caller did not come from an redirection."},
55 { "redirid", MATCH_REDIRID ,COND_TYPE_STRING,
56 "redirid=<digits>[-<digits>][,...]", "Matches if the caller has been redirected by the given (range(s) of) ID(s) or prefix(es))"},
57 { "time", MATCH_TIME, COND_TYPE_TIME,
58 "time=<minutes>[-<minutes>][,...]", "Matches if the caller calls within the given (range(s) of) time(s). (e.g. 0700-1900)"},
59 { "mday", MATCH_MDAY, COND_TYPE_MDAY,
60 "mday=<day>[-<day>][,...]", "Matches if the caller calls within the given (range(s) of) day(s) of the month. (1..31)"},
61 { "month", MATCH_MONTH, COND_TYPE_MONTH,
62 "month=<month>[-<month>][,...]", "Matches if the caller calls within the given (range(s) of) month(s). (1=January..12=December)"},
63 { "year", MATCH_YEAR, COND_TYPE_YEAR,
64 "year=<year>[-<year>][,...]", "Matches if the caller calls within the given (range(s) of) year(s). (1970..2106)"},
65 { "wday", MATCH_WDAY, COND_TYPE_WDAY,
66 "wday=<day>[-<day>][,...]", "Matches if the caller calls within the given (range(s) of) weekday(s). (1=Monday..7=Sunday)"},
67 { "capability", MATCH_CAPABILITY, COND_TYPE_CAPABILITY,
68 "capability=speech|audio|video|digital-restricted|digital-unrestricted|digital-unrestricted-tones[,...]", "Matches the given bearer capability(s)."},
69 { "infolayer1", MATCH_INFOLAYER1, COND_TYPE_INTEGER,
70 "infolayer1=<value>[,...]", "Matches the given information layer 1. (2=u-Law, 3=a-law, see info layer 1 in bearer capability.)"},
71 { "hlc", MATCH_HLC, COND_TYPE_HLC,
72 "hlc=telephony|faxg2g3|faxg4|teletex1|teletex2|teletex3|videotex1|videotex2|telex|mhs|osi|maintenance|management|audiovisual[,...]", "Matches the high layer capability(s)."},
73 { "file", MATCH_FILE, COND_TYPE_STRING,
74 "file=<path>[,...]", "Mathes is the given file exists and if the first character is '1'."},
75 { "execute", MATCH_EXECUTE, COND_TYPE_STRING,
76 "execute=<command>[,...]","Matches if the return value of the given command is greater 0."},
77 { "default", MATCH_DEFAULT, COND_TYPE_NULL,
78 "default","Matches if no further dialing could match."},
79 { "timeout", MATCH_TIMEOUT, COND_TYPE_INTEGER,
80 "timeout=<seconds>","Matches if the ruleset was entered AFTER given seconds."},
81 { "free", MATCH_FREE, COND_TYPE_IFATTR,
82 "free=<interface>:<channel>","Matches if the given minimum of channels are free."},
83 { "notfree", MATCH_NOTFREE, COND_TYPE_IFATTR,
84 "notfree=<interface>:<channel>","Matches if NOT the given minimum of channels are free."},
85 { "blocked", MATCH_DOWN, COND_TYPE_STRING,
86 "blocked=<interfaces>[,...]","Matches if all of the given interfaces are blocked."},
87 { "idle", MATCH_UP, COND_TYPE_STRING,
88 "idle=<interface>[,...]","Matches if any of the given interfaces is idle."},
89 { "busy", MATCH_BUSY, COND_TYPE_STRING,
90 "busy=<extension>[,...]","Matches if any of the given extension is busy."},
91 { "notbusy", MATCH_IDLE, COND_TYPE_STRING,
92 "notbusy=<extension>[,...]","Matches if any of the given extension is not busy."},
93 { "remote", MATCH_REMOTE, COND_TYPE_STRING,
94 "remote=<application name>","Matches if remote application is running."},
95 { "notremote", MATCH_NOTREMOTE,COND_TYPE_STRING,
96 "notremote=<application name>","Matches if remote application is not running."},
100 struct param_defs param_defs[] = {
102 "proceeding", PARAM_TYPE_NULL,
103 "proceeding", "Will set the call into 'proceeding' state to prevent dial timeout."},
105 "alerting", PARAM_TYPE_NULL,
106 "alerting", "Will set the call into 'altering' state."},
108 "connect", PARAM_TYPE_NULL,
109 "connect", "Will complete the call before processing the action. Audio path for external calls will be established."},
111 "extension", PARAM_TYPE_STRING,
112 "extension=<digits>", "Give extension name (digits) to relate this action to."},
114 "extensions", PARAM_TYPE_STRING,
115 "extensions=<extension>[,<extension>[,...]]", "One or more extensions may be given."},
117 "prefix", PARAM_TYPE_STRING,
118 "prefix=<digits>", "Add prefix in front of the dialed number."},
120 "capability", PARAM_TYPE_CAPABILITY,
121 "capability=speech|audio|video|digital-restricted|digital-unrestricted|digital-unrestricted-tones", "Alter the service type of the call."},
123 "bmode", PARAM_TYPE_BMODE,
124 "bmode=transparent|hdlc", "Alter the bchannel mode of the call. Use hdlc for data calls."},
126 "infolayer1", PARAM_TYPE_INTEGER,
127 "infolayer1=<value>", "Alter the layer 1 information of a call. Use 3 for ALAW or 2 for uLAW."},
129 "hlc", PARAM_TYPE_HLC,
130 "hlc=telephony|faxg2g3|faxg4|teletex1|teletex2|teletex3|videotex1|videotex2|telex|mhs|osi|maintenance|management|audiovisual", "Alter the HLC identification."},
132 "exthlc", PARAM_TYPE_HLC,
133 "exthlc=<value>", "Alter extended HLC value, see hlc. (Mainenance only, don't use it.)"},
135 "present", PARAM_TYPE_YESNO,
136 "present=yes|no", "Allow or restrict caller ID regardless what the caller wants."},
138 "diversion", PARAM_TYPE_DIVERSION,
139 "diversion=cfu|cfnr|cfb|cfp", "Set diversion type."},
141 "dest", PARAM_TYPE_DESTIN,
142 "dest=<string>", "Destination number to divert to. Use 'vbox' to divert to vbox. (cfu,cfnr,cfb only)"},
144 "select", PARAM_TYPE_NULL,
145 "select", "Lets the caller select the history of calls using keys '1'/'3' or '*'/'#'."},
147 "delay", PARAM_TYPE_INTEGER,
148 "delay=<seconds>", "Number of seconds to delay."},
150 "limit", PARAM_TYPE_INTEGER,
151 "limit=<retries>", "Number of maximum retries."},
153 "host", PARAM_TYPE_STRING,
154 "host=<string>", "Name of remote VoIP host."},
156 "port", PARAM_TYPE_STRING,
157 "port=<value>", "Alternate port to use if 'host' is given."},
159 "interfaces", PARAM_TYPE_STRING,
160 "interfaces=<interface>[,<interface>[,...]]", "Give one or a list of Interfaces to select a free channel from."},
162 "address", PARAM_TYPE_STRING,
163 "address=<string>", "Complete VoIP address. ( [user@]host[:port] )"},
165 "sample", PARAM_TYPE_STRING,
166 "sample=<file prefix>", "Filename of sample (current tone's dir) or full path to sample. ('.wav'/'.wave'/'.isdn' is added automatically."},
167 { PARAM_ANNOUNCEMENT,
168 "announcement",PARAM_TYPE_STRING,
169 "announcement=<file prefix>", "Filename of announcement (inside vbox recording dir) or full path to sample. ('.wav'/'.wave'/'.isdn' is added automatically."},
171 "ruleset", PARAM_TYPE_STRING,
172 "ruleset=<name>", "Ruleset to go to."},
174 "cause", PARAM_TYPE_INTEGER,
175 "cause=<cause value>", "Cause value when disconnecting. (21=reject 1=unassigned 63=service not available)"},
177 "location", PARAM_TYPE_INTEGER,
178 "location=<location value>", "Location of cause value when disconnecting. (0=user 1=private network sering local user)"},
180 "display", PARAM_TYPE_STRING,
181 "display=<text>", "Message to display on the caller's telephone. (internal only)"},
183 "ports", PARAM_TYPE_INTEGER,
184 "ports=<port>[,<port>[,...]]", "ISDN port[s] to use."},
186 "tpreset", PARAM_TYPE_INTEGER,
187 "tpreset=<seconds>", "Preset of countdown timer."},
189 "file", PARAM_TYPE_STRING,
190 "file=<full path>", "Full path to file name."},
192 "content", PARAM_TYPE_STRING,
193 "content=<string>", "Content to write into file."},
195 "append", PARAM_TYPE_NULL,
196 "append", "Will append to given file, rather than overwriting it."},
198 "execute", PARAM_TYPE_STRING,
199 "execute=<full path>", "Full path to script/command name. (Dialed digits are the argument 1.)"},
201 "param", PARAM_TYPE_STRING,
202 "param=<string>", "Optionally this parameter can be inserted as argument 1, others are shifted."},
204 "type", PARAM_TYPE_TYPE,
205 "type=unknown|subscriber|national|international", "Type of number to dial, default is 'unknown'."},
207 "complete", PARAM_TYPE_NULL,
208 "complete", "Indicates complete number as given by prefix. Proceeding of long distance calls may be faster."},
210 "callerid", PARAM_TYPE_STRING,
211 "callerid=<digits>", "Change caller ID to given string."},
212 { PARAM_CALLERIDTYPE,
213 "calleridtype",PARAM_TYPE_CALLERIDTYPE,
214 "calleridtype=[unknown|subscriber|national|international]", "Type of caller ID. For normal MSN use 'unknown'"},
216 "callto", PARAM_TYPE_STRING,
217 "callto=<digits>", "Where to call back. By default the caller ID is used."},
219 "room", PARAM_TYPE_INTEGER,
220 "room=<digits>", "Conference room number, must be greater 0, as in real life."},
222 "jingle", PARAM_TYPE_NULL,
223 "jingle", "Conference members will hear a jingle if a member joins."},
225 "timeout", PARAM_TYPE_INTEGER,
226 "timeout=<seconds>", "Timeout before continue with next action."},
228 "nopassword", PARAM_TYPE_NULL,
229 "nopassword", "Don't ask for password. Be sure to authenticate right via real caller ID."},
231 "strip", PARAM_TYPE_NULL,
232 "strip", "Remove digits that were required to match this rule."},
234 "application",PARAM_TYPE_STRING,
235 "application=<name>", "Name of remote application to make call to."},
237 "context", PARAM_TYPE_STRING,
238 "context=<context>", "Give context parameter to the remote application."},
240 "exten", PARAM_TYPE_STRING,
241 "exten=<extension>", "Give exten parameter to the remote application. (overrides dialed number)"},
243 "on", PARAM_TYPE_STRING,
244 "on=[init|hangup]", "Defines if the action is executed on call init or on hangup."},
246 "keypad", PARAM_TYPE_NULL,
247 "keypad", "Use 'keypad facility' for dialing, instead of 'called number'."},
248 { 0, NULL, 0, NULL, NULL}
251 struct action_defs action_defs[] = {
253 "extern", &EndpointAppPBX::action_init_call, &EndpointAppPBX::action_dialing_external, &EndpointAppPBX::action_hangup_call,
254 PARAM_CONNECT | PARAM_PREFIX | PARAM_COMPLETE | PARAM_TYPE | PARAM_CAPA | PARAM_BMODE | PARAM_INFO1 | PARAM_HLC | PARAM_EXTHLC | PARAM_PRESENT | PARAM_INTERFACES | PARAM_CALLERID | PARAM_CALLERIDTYPE | PARAM_KEYPAD | PARAM_TIMEOUT,
255 "Call is routed to extern number as dialed."},
257 "intern", &EndpointAppPBX::action_init_call, &EndpointAppPBX::action_dialing_internal, &EndpointAppPBX::action_hangup_call,
258 PARAM_CONNECT | PARAM_EXTENSION | PARAM_TYPE | PARAM_CAPA | PARAM_BMODE | PARAM_INFO1 | PARAM_HLC | PARAM_EXTHLC | PARAM_PRESENT | PARAM_TIMEOUT,
259 "Call is routed to intern extension as given by the dialed number or specified by option."},
261 "outdial", &EndpointAppPBX::action_init_call, &EndpointAppPBX::action_dialing_external, &EndpointAppPBX::action_hangup_call,
262 PARAM_CONNECT | PARAM_PREFIX | PARAM_COMPLETE | PARAM_TYPE | PARAM_CAPA | PARAM_BMODE | PARAM_INFO1 | PARAM_HLC | PARAM_EXTHLC | PARAM_PRESENT | PARAM_INTERFACES | PARAM_CALLERID | PARAM_CALLERIDTYPE | PARAM_KEYPAD | PARAM_TIMEOUT,
265 "remote", &EndpointAppPBX::action_init_remote, &EndpointAppPBX::action_dialing_remote, &EndpointAppPBX::action_hangup_call,
266 PARAM_CONNECT | PARAM_APPLICATION | PARAM_CONTEXT | PARAM_EXTEN | PARAM_TIMEOUT,
267 "Call is routed to Remote application, like Asterisk."},
268 { ACTION_VBOX_RECORD,
269 "vbox-record",&EndpointAppPBX::action_init_call, &EndpointAppPBX::action_dialing_vbox_record, &EndpointAppPBX::action_hangup_call,
270 PARAM_CONNECT | PARAM_EXTENSION | PARAM_ANNOUNCEMENT | PARAM_TIMEOUT,
271 "Caller is routed to the voice box of given extension."},
273 "partyline",&EndpointAppPBX::action_init_partyline, NULL, &EndpointAppPBX::action_hangup_call,
274 PARAM_ROOM | PARAM_JINGLE,
275 "Caller is participating the conference with the given room number."},
277 "login", NULL, &EndpointAppPBX::action_dialing_login, NULL,
278 PARAM_CONNECT | PARAM_EXTENSION | PARAM_NOPASSWORD,
279 "Log into the given extension. Password required."},
281 "callerid", &EndpointAppPBX::action_init_change_callerid, &EndpointAppPBX::action_dialing_callerid, NULL,
282 PARAM_CONNECT | PARAM_CALLERID | PARAM_CALLERIDTYPE | PARAM_PRESENT,
283 "Caller changes the caller ID for all calls."},
284 { ACTION_CALLERIDNEXT,
285 "calleridnext",&EndpointAppPBX::action_init_change_callerid, &EndpointAppPBX::action_dialing_calleridnext, NULL,
286 PARAM_CONNECT | PARAM_CALLERID | PARAM_CALLERIDTYPE | PARAM_PRESENT,
287 "Caller changes the caller ID for the next call."},
289 "forward", &EndpointAppPBX::action_init_change_forward, &EndpointAppPBX::action_dialing_forward, NULL,
290 PARAM_CONNECT | PARAM_DIVERSION | PARAM_DEST | PARAM_DELAY,
291 "Caller changes the diversion of given type to the given destination or voice box."},
293 "redial", &EndpointAppPBX::action_init_redial_reply, &EndpointAppPBX::action_dialing_redial, NULL,
294 PARAM_CONNECT | PARAM_SELECT,
295 "Caller redials. (last outgoing call(s))"},
297 "reply", &EndpointAppPBX::action_init_redial_reply, &EndpointAppPBX::action_dialing_reply, NULL,
298 PARAM_CONNECT | PARAM_SELECT,
299 "Caller replies. (last incoming call(s))"},
301 "powerdial", NULL, &EndpointAppPBX::action_dialing_powerdial, NULL,
302 PARAM_CONNECT | PARAM_DELAY | PARAM_LIMIT | PARAM_TIMEOUT,
303 "Caller redials using powerdialing."},
305 "callback", NULL, &EndpointAppPBX::action_dialing_callback, &EndpointAppPBX::action_hangup_callback,
306 PARAM_PROCEEDING | PARAM_ALERTING | PARAM_CONNECT | PARAM_EXTENSION | PARAM_DELAY | PARAM_CALLTO | PARAM_PREFIX,
307 "Caller will use the callback service. After disconnecting, the callback is triggered."},
309 "abbrev", NULL, &EndpointAppPBX::action_dialing_abbrev, NULL,
311 "Caller dials abbreviation."},
313 "test", NULL, &EndpointAppPBX::action_dialing_test, NULL,
314 PARAM_CONNECT | PARAM_PREFIX | PARAM_TIMEOUT,
315 "Caller dials test mode."},
317 "play", &EndpointAppPBX::action_init_play, NULL, NULL,
318 PARAM_PROCEEDING | PARAM_ALERTING | PARAM_CONNECT | PARAM_SAMPLE | PARAM_TIMEOUT,
319 "Plays the given sample."},
321 "vbox-play", &EndpointAppPBX::action_init_vbox_play, &EndpointAppPBX::action_dialing_vbox_play, NULL,
323 "Caller listens to her voice box or to given extension."},
325 "calculator", NULL, &EndpointAppPBX::action_dialing_calculator, NULL,
327 "Caller calls the calculator."},
329 "timer", NULL, &EndpointAppPBX::action_dialing_timer, NULL,
330 PARAM_CONNECT | PARAM_TPRESET | PARAM_TIMEOUT,
332 // "Caller calls the timer."},
334 "goto", NULL, &EndpointAppPBX::action_dialing_goto, NULL,
335 PARAM_PROCEEDING | PARAM_ALERTING | PARAM_CONNECT | PARAM_RULESET | PARAM_STRIP | PARAM_SAMPLE,
336 "Jump to given ruleset and optionally play sample. Dialed digits are not flushed."},
338 "menu", NULL, &EndpointAppPBX::action_dialing_menu, NULL,
339 PARAM_CONNECT | PARAM_RULESET | PARAM_SAMPLE,
340 "Same as 'goto', but flushes all digits dialed so far."},
342 "disconnect", NULL, &EndpointAppPBX::action_dialing_disconnect, NULL,
343 PARAM_CONNECT | PARAM_CAUSE | PARAM_LOCATION | PARAM_SAMPLE | PARAM_DISPLAY,
344 "Caller gets disconnected optionally with given cause and given sample and given display text."},
346 "release", NULL, &EndpointAppPBX::action_dialing_release, NULL,
347 PARAM_CONNECT | PARAM_CAUSE | PARAM_LOCATION | PARAM_DISPLAY,
348 "Same as 'disconnect', but using RELEASE message on ISDN."},
350 "deflect", NULL, &EndpointAppPBX::action_dialing_deflect, NULL,
353 // "External call is deflected to the given destination within the telephone network."},
355 "setforward", NULL, &EndpointAppPBX::action_dialing_setforward, NULL,
356 PARAM_CONNECT | PARAM_DIVERSION | PARAM_DEST | PARAM_PORT,
358 // "The call forward is set within the telephone network of the external line."},
360 "execute", &EndpointAppPBX::action_init_execute, NULL, &EndpointAppPBX::action_hangup_execute,
361 PARAM_CONNECT | PARAM_EXECUTE | PARAM_PARAM | PARAM_ON | PARAM_TIMEOUT,
362 "Executes the given script file. The file must terminate quickly, because it will halt the PBX."},
364 "file", NULL, NULL, &EndpointAppPBX::action_hangup_file,
365 PARAM_CONNECT | PARAM_FILE | PARAM_CONTENT | PARAM_APPEND,
366 "Writes givent content to given file. If content is not given, the dialed digits are written."},
368 "pick", &EndpointAppPBX::action_init_pick, NULL, NULL,
370 "Pick up a call that is ringing on any phone. Extensions may be given to limit the picking ability."},
372 "password", NULL, &EndpointAppPBX::action_dialing_password, NULL,
375 { ACTION_PASSWORD_WRITE,
376 "password_wr",NULL, &EndpointAppPBX::action_dialing_password_wr, NULL,
380 "nothing", NULL, NULL, NULL,
381 PARAM_PROCEEDING | PARAM_ALERTING | PARAM_CONNECT | PARAM_TIMEOUT,
382 "does nothing. Usefull to wait for calls to be released completely, by giving timeout value."},
384 "efi", &EndpointAppPBX::action_init_efi, NULL, NULL,
385 PARAM_PROCEEDING | PARAM_ALERTING | PARAM_CONNECT,
386 "Elektronische Fernsprecher Identifikation - announces caller ID."},
388 NULL, NULL, NULL, NULL, 0, NULL}
392 /* display documentation of rules */
394 void doc_rules(const char *name)
400 while(action_defs[i].name) {
401 if (!strcasecmp(action_defs[i].name, name))
405 if (!action_defs[i].name) {
406 fprintf(stderr, "Given action '%s' unknown.\n", name);
409 name = action_defs[i].name;
412 printf("Syntax overview:\n");
413 printf("----------------\n\n");
414 printf("[ruleset]\n");
415 printf("<condition> ... : <action> [parameter ...] [timeout=X : <action> ...]\n");
417 printf("Please refer to the documentation for description on rule format.\n\n");
420 printf("Available conditions to match:\n");
421 printf("------------------------------\n\n");
423 while(cond_defs[i].name) {
424 printf("Usage: %s\n", cond_defs[i].doc);
425 printf("%s\n\n", cond_defs[i].help);
429 printf("Available actions with their parameters:\n");
430 printf("----------------------------------------\n\n");
432 printf("Detailes parameter description of action:\n");
433 printf("-----------------------------------------\n\n");
436 while(action_defs[i].name) {
437 if (name && !!strcmp(action_defs[i].name,name)) { /* not selected */
441 if (!action_defs[i].help) { /* not internal actions */
445 printf("Usage: %s", action_defs[i].name);
448 if ((1LL<<j) & action_defs[i].params)
449 printf(" [%s]", param_defs[j].doc);
452 printf("\n%s\n\n", action_defs[i].help);
453 if (name) { /* only show parameter help for specific action */
456 if ((1LL<<j) & action_defs[i].params)
457 printf("%s:\n\t%s\n", param_defs[j].doc, param_defs[j].help);
466 void ruleset_free(struct route_ruleset *ruleset_start)
468 struct route_ruleset *ruleset;
469 struct route_rule *rule;
470 struct route_cond *cond;
471 struct route_action *action;
472 struct route_param *param;
474 while(ruleset_start) {
475 ruleset = ruleset_start;
476 ruleset_start = ruleset->next;
477 while(ruleset->rule_first) {
478 rule = ruleset->rule_first;
479 ruleset->rule_first = rule->next;
480 while(rule->cond_first) {
481 cond = rule->cond_first;
482 if (cond->string_value) {
483 FREE(cond->string_value, 0);
486 if (cond->string_value_to) {
487 FREE(cond->string_value_to, 0);
490 rule->cond_first = cond->next;
491 FREE(cond, sizeof(struct route_cond));
494 while(rule->action_first) {
495 action = rule->action_first;
496 rule->action_first = action->next;
497 while(action->param_first) {
498 param = action->param_first;
499 action->param_first = param->next;
500 if (param->string_value) {
501 FREE(param->string_value, 0);
504 FREE(param, sizeof(struct route_param));
507 FREE(action, sizeof(struct route_action));
510 FREE(rule, sizeof(struct route_rule));
513 FREE(ruleset, sizeof(struct route_ruleset));
518 void ruleset_debug(struct route_ruleset *ruleset_start)
520 struct route_ruleset *ruleset;
521 struct route_rule *rule;
522 struct route_cond *cond;
523 struct route_action *action;
524 struct route_param *param;
527 ruleset = ruleset_start;
529 printf("Ruleset: '%s'\n", ruleset->name);
530 rule = ruleset->rule_first;
534 cond = rule->cond_first;
537 printf(" Condition:");
541 printf(" %s", cond_defs[cond->index].name);
542 if (cond->value_type != VALUE_TYPE_NULL)
545 switch(cond->value_type) {
546 case VALUE_TYPE_NULL:
549 case VALUE_TYPE_INTEGER:
550 printf("%d", cond->integer_value);
553 case VALUE_TYPE_INTEGER_RANGE:
554 printf("%d-%d", cond->integer_value, cond->integer_value_to);
557 case VALUE_TYPE_STRING:
558 printf("'%s'", cond->string_value);
561 case VALUE_TYPE_STRING_RANGE:
562 printf("'%s'-'%s'", cond->string_value, cond->string_value_to);
566 printf("Software error: VALUE_TYPE_* %d not known in function '%s' line=%d", cond->value_type, __FUNCTION__, __LINE__);
568 if (cond->value_extension && cond->next) {
571 goto next_cond_value;
579 action = rule->action_first;
581 printf(" Action: %s\n", action_defs[action->index].name);
584 param = action->param_first;
591 printf(" %s", param_defs[param->index].name);
592 if (param->value_type != VALUE_TYPE_NULL)
594 switch(param->value_type) {
595 case VALUE_TYPE_NULL:
598 case VALUE_TYPE_INTEGER:
599 if (param_defs[param->index].type == PARAM_TYPE_CALLERIDTYPE) {
600 switch(param->integer_value) {
601 case INFO_NTYPE_UNKNOWN:
604 case INFO_NTYPE_SUBSCRIBER:
605 printf("subscriber");
607 case INFO_NTYPE_NATIONAL:
610 case INFO_NTYPE_INTERNATIONAL:
611 printf("international");
614 printf("unknown(%d)", param->integer_value);
618 if (param_defs[param->index].type == PARAM_TYPE_CAPABILITY) {
619 switch(param->integer_value) {
629 case INFO_BC_DATARESTRICTED:
630 printf("digital-restricted");
632 case INFO_BC_DATAUNRESTRICTED:
633 printf("digital-unrestricted");
635 case INFO_BC_DATAUNRESTRICTED_TONES:
636 printf("digital-unrestricted-tones");
639 printf("unknown(%d)", param->integer_value);
643 if (param_defs[param->index].type == PARAM_TYPE_DIVERSION) {
644 switch(param->integer_value) {
645 case INFO_DIVERSION_CFU:
648 case INFO_DIVERSION_CFNR:
651 case INFO_DIVERSION_CFB:
654 case INFO_DIVERSION_CFP:
658 printf("unknown(%d)", param->integer_value);
662 if (param_defs[param->index].type == PARAM_TYPE_TYPE) {
663 switch(param->integer_value) {
664 case INFO_NTYPE_UNKNOWN:
667 case INFO_NTYPE_SUBSCRIBER:
668 printf("subscriber");
670 case INFO_NTYPE_NATIONAL:
673 case INFO_NTYPE_INTERNATIONAL:
674 printf("international");
677 printf("unknown(%d)", param->integer_value);
681 if (param_defs[param->index].type == PARAM_TYPE_YESNO) {
682 switch(param->integer_value) {
690 printf("unknown(%d)", param->integer_value);
694 if (param_defs[param->index].type == PARAM_TYPE_NULL) {
697 printf("%d", param->integer_value);
700 case VALUE_TYPE_STRING:
701 printf("'%s'", param->string_value);
705 printf("Software error: VALUE_TYPE_* %d not known in function '%s' line=%d", param->value_type, __FUNCTION__, __LINE__);
712 printf(" Timeout: %d\n", action->timeout);
713 action = action->next;
719 ruleset = ruleset->next;
727 static char *read_string(char *p, char *key, int key_size, const char *special)
746 if (--key_size == 0) {
747 UPRINT(key, "\001String too long.");
752 UPRINT(key, "\001Unexpected end of line inside quotes.");
758 if (strchr(special, *p)) {
765 UPRINT(key, "\001Unexpected end of line.");
769 if (--key_size == 0) {
770 UPRINT(key, "\001String too long.");
778 char ruleset_error[256];
779 struct route_ruleset *ruleset_parse(void)
784 unsigned long long j;
788 FILE *fp[MAXNESTING];
789 char filename[MAXNESTING][256];
790 int line[MAXNESTING];
797 int expecting = 1; /* 1 = expecting ruleset */
801 integer_to; /* condition index, .. */
802 struct route_ruleset *ruleset_start = NULL, *ruleset;
803 struct route_ruleset **ruleset_pointer = &ruleset_start;
804 struct route_rule *rule;
805 struct route_rule **rule_pointer = NULL;
806 struct route_cond *cond;
807 struct route_cond **cond_pointer = NULL;
808 struct route_action *action;
809 struct route_action **action_pointer = NULL;
810 struct route_param *param;
811 struct route_param **param_pointer = NULL;
813 unsigned long long allowed_params;
815 /* check the integrity of IDs for ACTION_* and PARAM_* */
817 while(action_defs[i].name) {
818 if (action_defs[i].id != i) {
819 PERROR("Software Error action '%s' must have id of %d, but has %d.\n",
820 action_defs[i].name, i, action_defs[i].id);
826 while(param_defs[i].name) {
827 if (param_defs[i].id != j) {
828 PERROR("Software Error param '%s' must have id of 0x%llx, but has 0x%llx.\n",
829 param_defs[i].name, j, param_defs[i].id);
836 SPRINT(filename[0], "%s/routing.conf", CONFIG_DATA);
838 if (!(fp[0]=fopen(filename[0],"r")))
840 PERROR("Cannot open %s\n",filename[0]);
849 while((GETLINE(buffer, fp[nesting])))
862 /* skip spaces, if any */
873 /* don't skip "define" */
874 if (!!strncmp(p, "define", 6))
886 p = read_string(p, key, sizeof(key), " ");
887 if (key[0] == 1) { /* error */
888 SPRINT(failure, "Parsing Filename failed: %s", key+1);
891 if (nesting == MAXNESTING-1) {
892 SPRINT(failure, "'include' is nesting too deep.\n");
896 SCPY(filename[nesting+1], key);
898 SPRINT(filename[nesting+1], "%s/%s", CONFIG_DATA, key);
899 if (!(fp[nesting+1]=fopen(filename[nesting+1],"r"))) {
900 PERROR("Cannot open %s\n", filename[nesting+1]);
907 if (*p == '/') if (p[1] == '/')
910 /* skip empty lines */
914 /* expecting ruleset */
919 SPRINT(failure, "Expecting ruleset name starting with '['.");
924 /* reading ruleset name text */
926 while(*p>' ' && *p<127 && *p!=']') {
927 if (*p>='A' && *p<='Z') *p = *p-'A'+'a'; /* lower case */
929 if (i == sizeof(key)) i--; /* limit */
932 if (key[0] == '\0') {
933 SPRINT(failure, "Missing ruleset name after '['.");
937 /* expecting ] and nothing more */
939 SPRINT(failure, "Expecting ']' after ruleset name.");
944 SPRINT(failure, "Unexpected character after ruleset name.");
948 /* check for duplicate rulesets */
949 ruleset = ruleset_start;
951 if (!strcmp(ruleset->name, key)) {
952 SPRINT(failure, "Duplicate ruleset '%s', already defined in file '%s' line %d.", key, ruleset->file, ruleset->line);
955 ruleset = ruleset->next;
959 ruleset = (struct route_ruleset *)MALLOC(sizeof(struct route_ruleset));
961 *ruleset_pointer = ruleset;
962 ruleset_pointer = &(ruleset->next);
963 SCPY(ruleset->name, key);
964 SCPY(ruleset->file, filename[nesting]);
965 ruleset->line = line[nesting];
966 rule_pointer = &(ruleset->rule_first);
971 /* for new ruleset [ */
976 /* Alloc memory for rule */
977 rule = (struct route_rule *)MALLOC(sizeof(struct route_rule));
979 *rule_pointer = rule;
980 rule_pointer = &(rule->next);
981 cond_pointer = &(rule->cond_first);
982 action_pointer = &(rule->action_first);
983 SCPY(rule->file, filename[nesting]);
984 rule->line = line[nesting];
986 /* loop CONDITIONS */
987 while(*p!=':' && *p!='\0') {
990 while((*p>='a' && *p<='z') || (*p>='A' && *p<='Z') || (*p>='0' && *p<='9')) {
991 if (*p>='A' && *p<='Z') *p = *p-'A'+'a'; /* lower case */
993 if (i == sizeof(key)) i--; /* limit */
996 if (key[0] == '\0') {
997 SPRINT(failure, "Expecting condition item name or ':' for end of condition list.");
1000 if (*p!=' ' && *p!='=') {
1001 SPRINT(failure, "Illegal character '%c' after condition name '%s'. Expecting '=' for equation or ' ' to seperate condition items.", *p, key);
1005 /* check if condition exists */
1007 while(cond_defs[index].name) {
1008 if (!strcmp(cond_defs[index].name, key))
1012 if (cond_defs[index].name == NULL) {
1013 SPRINT(failure, "Unknown condition item name '%s'.", key);
1017 /* items without values must not have any parameter */
1018 if (cond_defs[index].type == COND_TYPE_NULL) {
1020 SPRINT(failure, "Condition item '%s' must not have any value. Don't use '=' for this type of condition.", key);
1024 SPRINT(failure, "Condition item '%s' must not have any value. Expecting ' ' or tab after item name.", key);
1030 SPRINT(failure, "Condition item '%s' must have at least one value, '=' expected, and not a space.", key);
1034 SPRINT(failure, "Condition item '%s' must have at least one value, '=' expected.", key);
1040 /* check for duplicate condition */
1041 cond = rule->cond_first;
1043 if (cond->index == index) {
1044 SPRINT(failure, "Duplicate condition '%s', use ',' to give multiple values.", key);
1051 /* Alloc memory for item */
1052 cond = (struct route_cond *)MALLOC(sizeof(struct route_cond));
1054 *cond_pointer = cond;
1055 cond_pointer = &(cond->next);
1056 cond->index = index;
1057 cond->match = cond_defs[index].match;
1058 switch(cond_defs[index].type) {
1059 case COND_TYPE_NULL:
1061 SPRINT(failure, "Expecting no value.");
1064 value_type = VALUE_TYPE_NULL;
1067 /* parse all integer values/ranges */
1068 case COND_TYPE_INTEGER:
1069 case COND_TYPE_TIME:
1070 case COND_TYPE_MDAY:
1071 case COND_TYPE_MONTH:
1072 case COND_TYPE_WDAY:
1073 case COND_TYPE_YEAR:
1074 integer = integer_to = 0;
1075 if (*p==',' || *p==' ' || *p=='\0') {
1076 SPRINT(failure, "Missing integer value.");
1079 while(*p>='0' && *p<='9') {
1080 integer = integer*10 + *p-'0';
1083 value_type = VALUE_TYPE_INTEGER;
1086 if (*p==',' || *p==' ' || *p=='\0') {
1087 SPRINT(failure, "Missing integer value.");
1090 while(*p>='0' && *p<='9') {
1091 integer_to = integer_to*10 + *p-'0';
1094 value_type = VALUE_TYPE_INTEGER_RANGE;
1096 if (cond_defs[index].type == COND_TYPE_TIME) {
1097 // Simon: i store the time as decimal, later i compare it correctly:
1098 // hours * 100 + minutes
1099 if (integer == 2400)
1101 if (integer >= 2400) {
1103 SPRINT(failure, "Given time '%d' not in range 0000..2359 (or 2400 for 0000)", integer);
1106 if (integer%100 >= 60)
1107 goto timeoutofrange1;
1108 if (value_type == VALUE_TYPE_INTEGER)
1110 if (integer_to == 2400)
1112 if (integer_to >= 2400) {
1114 SPRINT(failure, "Given time '%d' not in range 0000..2359 (or 2400 for 0000)", integer_to);
1117 if (integer_to%100 >= 60)
1118 goto timeoutofrange2;
1120 if (cond_defs[index].type == COND_TYPE_MDAY) {
1121 if (integer<1 || integer>31) {
1122 SPRINT(failure, "Given day-of-month '%d' not in range 1..31", integer);
1125 if (value_type == VALUE_TYPE_INTEGER)
1127 if (integer_to<1 || integer_to>31) {
1128 SPRINT(failure, "Given day-of-month '%d' not in range 1..31", integer_to);
1132 if (cond_defs[index].type == COND_TYPE_WDAY) {
1133 if (integer<1 || integer>7) {
1134 SPRINT(failure, "Given day-of-week '%d' not in range 1..7", integer);
1137 if (value_type == VALUE_TYPE_INTEGER)
1139 if (integer_to<1 || integer_to>7) {
1140 SPRINT(failure, "Given day-of-week '%d' not in range 1..7", integer_to);
1144 if (cond_defs[index].type == COND_TYPE_MONTH) {
1145 if (integer<1 || integer>12) {
1146 SPRINT(failure, "Given month '%d' not in range 1..12", integer);
1149 if (value_type == VALUE_TYPE_INTEGER)
1151 if (integer_to<1 || integer_to>12) {
1152 SPRINT(failure, "Given month '%d' not in range 1..12", integer_to);
1156 if (cond_defs[index].type == COND_TYPE_YEAR) {
1157 if (integer<1970 || integer>2106) {
1158 SPRINT(failure, "Given year '%d' not in range 1970..2106", integer);
1161 if (value_type == VALUE_TYPE_INTEGER)
1163 if (integer_to<1970 || integer_to>2106) {
1164 SPRINT(failure, "Given year '%d' not in range 1970..2106", integer_to);
1169 cond->integer_value = integer;
1170 cond->integer_value_to = integer_to;
1171 cond->value_type = value_type;
1174 /* parse all string values/ranges */
1175 case COND_TYPE_STRING:
1176 key[0] = key_to[0] = '\0';
1177 if (*p==',' || *p==' ' || *p=='\0') {
1178 SPRINT(failure, "Missing string value, use \"\" for empty string.");
1181 p = read_string(p, key, sizeof(key), "-, ");
1182 if (key[0] == 1) { /* error */
1183 SPRINT(failure, "Parsing String failed: %s", key+1);
1186 value_type = VALUE_TYPE_STRING;
1189 if (*p==',' || *p==' ' || *p=='\0') {
1190 SPRINT(failure, "Missing string value, use \"\" for empty string.");
1193 p = read_string(p, key_to, sizeof(key_to), "-, ");
1194 if (key_to[0] == 1) { /* error */
1195 SPRINT(failure, "Parsing string failed: %s", key_to+1);
1198 value_type = VALUE_TYPE_STRING_RANGE;
1199 if (strlen(key) != strlen(key_to)) {
1200 SPRINT(failure, "Given range of strings \"%s\"-\"%s\" have unequal length.", key, key_to);
1203 if (key[0] == '\0') {
1204 SPRINT(failure, "Given range has no length.");
1209 cond->string_value = (char *)MALLOC(strlen(key)+1);
1211 UCPY(cond->string_value, key);
1212 if (value_type == VALUE_TYPE_STRING_RANGE) {
1213 cond->string_value_to = (char *)MALLOC(strlen(key_to)+1);
1215 UCPY(cond->string_value_to, key_to);
1216 cond->comp_string = strcmp(key, key_to);
1218 cond->value_type = value_type;
1221 /* parse service value */
1222 case COND_TYPE_CAPABILITY:
1223 if (!strncasecmp("speech", p, 6))
1224 cond->integer_value = INFO_BC_SPEECH;
1225 else if (!strncasecmp("audio", p, 5))
1226 cond->integer_value = INFO_BC_AUDIO;
1227 else if (!strncasecmp("video", p, 5))
1228 cond->integer_value = INFO_BC_VIDEO;
1229 else if (!strncasecmp("digital-restricted", p, 18))
1230 cond->integer_value = INFO_BC_DATARESTRICTED;
1231 else if (!strncasecmp("digital-unrestricted", p, 20))
1232 cond->integer_value = INFO_BC_DATAUNRESTRICTED;
1233 else if (!strncasecmp("digital-unrestricted-tones", p, 26))
1234 cond->integer_value = INFO_BC_DATAUNRESTRICTED_TONES;
1236 SPRINT(failure, "Given service type is invalid or misspelled.");
1239 cond->value_type = VALUE_TYPE_INTEGER;
1242 /* parse bmode value */
1243 case COND_TYPE_BMODE:
1244 if (!strncasecmp("transparent", p, 11))
1245 cond->integer_value = INFO_BMODE_CIRCUIT;
1246 else if (!strncasecmp("hdlc", p, 4))
1247 cond->integer_value = INFO_BMODE_PACKET;
1249 SPRINT(failure, "Given bchannel mode is invalid or misspelled.");
1252 cond->value_type = VALUE_TYPE_INTEGER;
1255 /* parse service value */
1257 if (!strncasecmp("telephony", p, 9))
1258 cond->integer_value = INFO_HLC_TELEPHONY;
1259 else if (!strncasecmp("faxg2g3", p, 7))
1260 cond->integer_value = INFO_HLC_FAXG2G3;
1261 else if (!strncasecmp("faxg4", p, 5))
1262 cond->integer_value = INFO_HLC_FAXG4;
1263 else if (!strncasecmp("teletex1", p, 8))
1264 cond->integer_value = INFO_HLC_TELETEX1;
1265 else if (!strncasecmp("teletex2", p, 8))
1266 cond->integer_value = INFO_HLC_TELETEX2;
1267 else if (!strncasecmp("teletex3", p, 8))
1268 cond->integer_value = INFO_HLC_TELETEX3;
1269 else if (!strncasecmp("videotex1", p, 9))
1270 cond->integer_value = INFO_HLC_VIDEOTEX1;
1271 else if (!strncasecmp("videotex2", p, 9))
1272 cond->integer_value = INFO_HLC_VIDEOTEX2;
1273 else if (!strncasecmp("telex", p, 5))
1274 cond->integer_value = INFO_HLC_TELEX;
1275 else if (!strncasecmp("mhs", p, 3))
1276 cond->integer_value = INFO_HLC_MHS;
1277 else if (!strncasecmp("osi", p, 3))
1278 cond->integer_value = INFO_HLC_OSI;
1279 else if (!strncasecmp("maintenance", p, 11))
1280 cond->integer_value = INFO_HLC_MAINTENANCE;
1281 else if (!strncasecmp("management", p, 10))
1282 cond->integer_value = INFO_HLC_MANAGEMENT;
1283 else if (!strncasecmp("audiovisual", p, 11))
1284 cond->integer_value = INFO_HLC_AUDIOVISUAL;
1286 SPRINT(failure, "Given HLC type is invalid or misspelled.");
1289 cond->value_type = VALUE_TYPE_INTEGER;
1292 /* parse interface attribute <if>:<value> */
1293 case COND_TYPE_IFATTR:
1294 key[0] = key_to[0] = '\0';
1295 if (*p==':' || *p==',' || *p==' ' || *p=='\0') {
1296 SPRINT(failure, "Missing interface name.");
1299 p = read_string(p, key, sizeof(key), ":-, ");
1300 if (key[0] == 1) { /* error */
1301 SPRINT(failure, "Parsing interface failed: %s", key+1);
1305 SPRINT(failure, "Expeciting kolon to seperate value behind interface name.");
1309 while(*p>='0' && *p<='9') {
1312 if (*p!=',' && *p!=' ' && *p!='\0') {
1313 SPRINT(failure, "Invalid characters behind value.");
1316 value_type = VALUE_TYPE_STRING;
1321 SPRINT(failure, "Software error: COND_TYPE_* %d not parsed in function '%s'", cond_defs[index].type, __FUNCTION__);
1324 /* if we have another value for that item, we attach it */
1328 cond->value_extension = 1;
1331 /* to seperate the items, a space is required */
1333 SPRINT(failure, "Character '%c' not expected here. Use ',' to seperate multiple possible values.", *p);
1345 /* we are done with CONDITIONS, so we expect the ACTION */
1347 SPRINT(failure, "Expecting ':' after condition item(s).");
1353 /* skip spaces, if any */
1361 /* read action name */
1363 while((*p>='a' && *p<='z') || (*p>='A' && *p<='Z') || (*p>='0' && *p<='9') || *p == '-') {
1364 if (*p>='A' && *p<='Z') *p = *p-'A'+'a'; /* lower case */
1366 if (i == sizeof(key)) i--; /* limit */
1369 if (key[0] == '\0') {
1370 SPRINT(failure, "Expecting action name.");
1374 /* check if item exists */
1376 while(action_defs[index].name) {
1377 if (!action_defs[index].help) { /* not internal actions */
1381 if (!strcmp(action_defs[index].name, key))
1385 if (action_defs[index].name == NULL) {
1386 SPRINT(failure, "Unknown action name '%s'.", key);
1389 allowed_params = action_defs[index].params;
1391 /* alloc memory for action */
1392 action = (struct route_action *)MALLOC(sizeof(struct route_action));
1394 *action_pointer = action;
1395 action_pointer = &(action->next);
1396 param_pointer = &(action->param_first);
1397 action->index = index;
1398 action->line = line[nesting];
1400 /* skip spaces after param name */
1410 /* read param text */
1412 while((*p>='a' && *p<='z') || (*p>='A' && *p<='Z') || (*p>='0' && *p<='9')) {
1413 if (*p>='A' && *p<='Z') *p = *p-'A'+'a'; /* lower case */
1415 if (i == sizeof(key)) i--; /* limit */
1418 if (key[0] == '\0') {
1419 SPRINT(failure, "Expecting parameter name.");
1423 /* check if item exists */
1425 while(param_defs[index].name) {
1426 if (!strcmp(param_defs[index].name, key))
1430 if (param_defs[index].name == NULL) {
1431 SPRINT(failure, "Unknown param name '%s'.", key);
1435 /* check if item is allowed for the action */
1436 if (!(param_defs[index].id & allowed_params)) {
1437 SPRINT(failure, "Param name '%s' exists, but not for this action.", key);
1441 /* params without values must not have any parameter */
1442 if (param_defs[index].type == PARAM_TYPE_NULL) {
1443 if (*p!=' ' && *p!='\0') {
1444 SPRINT(failure, "Parameter '%s' must not have any value.", key);
1449 SPRINT(failure, "Parameter '%s' must have at least one value, '=' expected and not a space.", key);
1453 SPRINT(failure, "Parameter '%s' must have at least one value, '=' expected.", key);
1459 /* special timeout value */
1460 if (!strcmp("timeout", key)) {
1461 if (action->timeout) {
1462 SPRINT(failure, "Duplicate timeout value.");
1465 if (*p==',' || *p==' ' || *p=='\0') {
1466 SPRINT(failure, "Missing integer value.");
1470 while(*p>='0' && *p<='9') {
1471 integer = integer*10 + *p-'0';
1475 SPRINT(failure, "Expecting timeout value greater 0.");
1478 if (*p!=' ' && *p!='\0') {
1479 SPRINT(failure, "Character '%c' not expected here. Use ' ' to seperate parameters.", *p);
1488 action->timeout = integer;
1489 /* check for next ACTION */
1497 /* check for duplicate parameters */
1498 param = action->param_first;
1500 if (param->index == index) {
1501 SPRINT(failure, "Duplicate parameter '%s', use ',' to give multiple values.", key);
1504 param = param->next;
1508 /* Alloc memory for param */
1509 param = (struct route_param *)MALLOC(sizeof(struct route_param));
1511 *param_pointer = param;
1512 param_pointer = &(param->next);
1513 param->index = index;
1514 param->id = param_defs[index].id;
1516 switch(param_defs[index].type) {
1517 /* parse null value */
1518 case PARAM_TYPE_NULL:
1519 param->value_type = VALUE_TYPE_NULL;
1522 /* parse integer value */
1523 case PARAM_TYPE_INTEGER:
1525 if (*p==',' || *p==' ' || *p=='\0') {
1526 SPRINT(failure, "Missing integer value.");
1529 while(*p>='0' && *p<='9') {
1530 integer = integer*10 + *p-'0';
1533 param->integer_value = integer;
1534 param->value_type = VALUE_TYPE_INTEGER;
1538 /* parse ports value */
1539 case PARAM_TYPE_PORTS:
1541 if (*p==',' || *p==' ' || *p=='\0') {
1542 SPRINT(failure, "Missing port number, omit parameter or give port number.");
1548 while(*p>='0' && *p<='9') {
1549 if (i < (int)sizeof(key)-1) {
1553 integer = integer*10 + *p-'0';
1556 if (integer > 255) {
1557 SPRINT(failure, "Port number too high.");
1561 if (i < (int)sizeof(key)-1) {
1571 /* parse string value */
1572 case PARAM_TYPE_STRING:
1573 case PARAM_TYPE_CALLERIDTYPE:
1574 case PARAM_TYPE_CAPABILITY:
1575 case PARAM_TYPE_BMODE:
1576 case PARAM_TYPE_HLC:
1577 case PARAM_TYPE_DIVERSION:
1578 case PARAM_TYPE_DESTIN:
1579 case PARAM_TYPE_TYPE:
1580 case PARAM_TYPE_YESNO:
1583 if (*p==',' || *p==' ' || *p=='\0') {
1584 SPRINT(failure, "Missing string value, use \"\" for empty string.");
1587 p = read_string(p, key, sizeof(key), " ");
1588 if (key[0] == 1) { /* error */
1589 SPRINT(failure, "Parsing string failed: %s", key+1);
1592 if (param_defs[index].type == PARAM_TYPE_CALLERIDTYPE) {
1593 param->value_type = VALUE_TYPE_INTEGER;
1594 if (!strcasecmp(key, "unknown")) {
1595 param->integer_value = INFO_NTYPE_UNKNOWN;
1598 if (!strcasecmp(key, "subscriber")) {
1599 param->integer_value = INFO_NTYPE_SUBSCRIBER;
1602 if (!strcasecmp(key, "national")) {
1603 param->integer_value = INFO_NTYPE_NATIONAL;
1606 if (!strcasecmp(key, "international")) {
1607 param->integer_value = INFO_NTYPE_INTERNATIONAL;
1610 SPRINT(failure, "Caller ID type '%s' unknown.", key);
1613 if (param_defs[index].type == PARAM_TYPE_ON) {
1614 param->value_type = VALUE_TYPE_INTEGER;
1615 if (!strcasecmp(key, "init")) {
1616 param->integer_value = INFO_ON_INIT;
1619 if (!strcasecmp(key, "hangup")) {
1620 param->integer_value = INFO_ON_HANGUP;
1623 SPRINT(failure, "Execute on '%s' unknown.", key);
1626 if (param_defs[index].type == PARAM_TYPE_CAPABILITY) {
1627 param->value_type = VALUE_TYPE_INTEGER;
1628 if (!strcasecmp(key, "speech")) {
1629 param->integer_value = INFO_BC_SPEECH;
1632 if (!strcasecmp(key, "audio")) {
1633 param->integer_value = INFO_BC_AUDIO;
1636 if (!strcasecmp(key, "video")) {
1637 param->integer_value = INFO_BC_VIDEO;
1640 if (!strcasecmp(key, "digital-restricted")) {
1641 param->integer_value = INFO_BC_DATARESTRICTED;
1644 if (!strcasecmp(key, "digital-unrestricted")) {
1645 param->integer_value = INFO_BC_DATAUNRESTRICTED;
1648 if (!strcasecmp(key, "digital-unrestricted-tones")) {
1649 param->integer_value = INFO_BC_DATAUNRESTRICTED_TONES;
1652 SPRINT(failure, "Service type '%s' unknown.", key);
1655 if (param_defs[index].type == PARAM_TYPE_BMODE) {
1656 param->value_type = VALUE_TYPE_INTEGER;
1657 if (!strcasecmp(key, "transparent")) {
1658 param->integer_value = INFO_BMODE_CIRCUIT;
1661 if (!strcasecmp(key, "hdlc")) {
1662 param->integer_value = INFO_BMODE_PACKET;
1665 SPRINT(failure, "Bchannel mode '%s' unknown.", key);
1668 if (param_defs[index].type == PARAM_TYPE_HLC) {
1669 param->value_type = VALUE_TYPE_INTEGER;
1670 if (!strcasecmp(key, "telephony")) {
1671 param->integer_value = INFO_HLC_TELEPHONY;
1674 if (!strcasecmp(key, "faxg2g3")) {
1675 param->integer_value = INFO_HLC_FAXG2G3;
1678 if (!strcasecmp(key, "faxg4")) {
1679 param->integer_value = INFO_HLC_FAXG4;
1682 if (!strcasecmp(key, "teletex1")) {
1683 param->integer_value = INFO_HLC_TELETEX1;
1686 if (!strcasecmp(key, "teletex2")) {
1687 param->integer_value = INFO_HLC_TELETEX2;
1690 if (!strcasecmp(key, "teletex3")) {
1691 param->integer_value = INFO_HLC_TELETEX3;
1694 if (!strcasecmp(key, "videotex1")) {
1695 param->integer_value = INFO_HLC_VIDEOTEX1;
1698 if (!strcasecmp(key, "videotex2")) {
1699 param->integer_value = INFO_HLC_VIDEOTEX2;
1702 if (!strcasecmp(key, "telex")) {
1703 param->integer_value = INFO_HLC_TELEX;
1706 if (!strcasecmp(key, "mhs")) {
1707 param->integer_value = INFO_HLC_MHS;
1710 if (!strcasecmp(key, "osi")) {
1711 param->integer_value = INFO_HLC_OSI;
1714 if (!strcasecmp(key, "maintenance")) {
1715 param->integer_value = INFO_HLC_MAINTENANCE;
1718 if (!strcasecmp(key, "management")) {
1719 param->integer_value = INFO_HLC_MANAGEMENT;
1722 if (!strcasecmp(key, "audiovisual")) {
1723 param->integer_value = INFO_HLC_AUDIOVISUAL;
1726 SPRINT(failure, "HLC type '%s' unknown.", key);
1729 if (param_defs[index].type == PARAM_TYPE_DIVERSION) {
1730 param->value_type = VALUE_TYPE_INTEGER;
1731 if (!strcasecmp(key, "cfu")) {
1732 param->integer_value = INFO_DIVERSION_CFU;
1735 if (!strcasecmp(key, "cfb")) {
1736 param->integer_value = INFO_DIVERSION_CFB;
1739 if (!strcasecmp(key, "cfnr")) {
1740 param->integer_value = INFO_DIVERSION_CFNR;
1743 if (!strcasecmp(key, "cfp")) {
1744 param->integer_value = INFO_DIVERSION_CFP;
1747 SPRINT(failure, "Diversion type '%s' unknown.", key);
1750 if (param_defs[index].type == PARAM_TYPE_TYPE) {
1751 param->value_type = VALUE_TYPE_INTEGER;
1752 if (!strcasecmp(key, "unknown")) {
1753 param->integer_value = INFO_NTYPE_UNKNOWN;
1756 if (!strcasecmp(key, "subscriber")) {
1757 param->integer_value = INFO_NTYPE_SUBSCRIBER;
1760 if (!strcasecmp(key, "national")) {
1761 param->integer_value = INFO_NTYPE_NATIONAL;
1764 if (!strcasecmp(key, "international")) {
1765 param->integer_value = INFO_NTYPE_INTERNATIONAL;
1768 SPRINT(failure, "Number type '%s' unknown.", key);
1771 if (param_defs[index].type == PARAM_TYPE_YESNO) {
1772 param->value_type = VALUE_TYPE_INTEGER;
1773 if (!strcasecmp(key, "yes")) {
1774 param->integer_value = 1;
1777 if (!strcasecmp(key, "no")) {
1778 param->integer_value = 0;
1781 SPRINT(failure, "Value '%s' unknown. ('yes' or 'no')", key);
1784 param->string_value = (char *)MALLOC(strlen(key)+1);
1786 UCPY(param->string_value, key);
1787 param->value_type = VALUE_TYPE_STRING;
1791 SPRINT(failure, "Software error: PARAM_TYPE_* %d not parsed in function '%s'", param_defs[index].type, __FUNCTION__);
1798 param->value_extension = 1;
1799 goto nextparamvalue;
1806 /* to seperate the items, a space is required */
1808 SPRINT(failure, "Character '%c' not expected here. Use ' ' to seperate parameters, or ',' for multiple values.", *p);
1819 /* check for next ACTION */
1827 fclose(fp[nesting--]);
1833 if (!ruleset_start) {
1834 SPRINT(failure, "No ruleset defined.");
1836 return(ruleset_start);
1839 printf("While parsing %s, an error occurred in line %d:\n", filename[nesting], line[nesting]);
1840 printf("-> %s\n", buffer);
1841 memset(pointer, ' ', sizeof(pointer));
1842 pointer[p-buffer] = '^';
1843 pointer[p-buffer+1] = '\0';
1844 printf(" %s\n", pointer);
1845 printf("%s\n", failure);
1846 SPRINT(ruleset_error, "Error in file %s, line %d: %s", filename[nesting], line[nesting], failure);
1849 while(nesting >= 0) {
1850 fclose(fp[nesting--]);
1854 ruleset_free(ruleset_start);
1859 * return ruleset by name
1861 struct route_ruleset *getrulesetbyname(const char *name)
1863 struct route_ruleset *ruleset = ruleset_first;
1866 if (!strcasecmp(name, ruleset->name)) {
1869 ruleset = ruleset->next;
1871 PDEBUG(DEBUG_ROUTE, "ruleset %s %s.\n", name, ruleset?"found":"not found");
1876 * parses the current ruleset and returns action
1878 struct route_action *EndpointAppPBX::route(struct route_ruleset *ruleset)
1881 couldmatch = 0, /* any rule could match */
1888 struct route_rule *rule = ruleset->rule_first;
1889 struct route_cond *cond;
1890 struct route_action *action = NULL;
1891 unsigned long comp_len;
1894 char *argv[11]; /* check also number of args below */
1895 char callerid[64], callerid2[64], redirid[64];
1899 long long timeout, now_ll = 0, match_timeout = 0;
1900 struct timeval current_time;
1901 struct mISDNport *mISDNport;
1902 struct admin_list *admin;
1906 /* reset timeout action */
1907 e_match_to_action = NULL;
1909 SCPY(callerid, numberrize_callerinfo(e_callerinfo.id, e_callerinfo.ntype, options.national, options.international));
1910 SCPY(callerid2, numberrize_callerinfo(e_callerinfo.id2, e_callerinfo.ntype2, options.national, options.international));
1911 SCPY(redirid, numberrize_callerinfo(e_redirinfo.id, e_redirinfo.ntype, options.national, options.international));
1913 PDEBUG(DEBUG_ROUTE, "parsing ruleset '%s'\n", ruleset->name);
1915 PDEBUG(DEBUG_ROUTE, "checking rule in line %d\n", rule->line);
1916 match = 1; /* this rule matches */
1917 dialing_required = 0;
1918 timeout = 0; /* timeout time */
1919 cond = rule->cond_first;
1921 condition = 0; /* any condition element is true (1) or could be true (2) */
1923 istrue = 0; /* this condition-element is true */
1924 couldbetrue = 0; /* this conditions-element could be true */
1925 switch(cond->match) {
1927 if (!e_ext.number[0])
1932 if (e_ext.number[0])
1937 if (ea_endpoint->ep_portlist)
1938 if ((ea_endpoint->ep_portlist->port_type & PORT_CLASS_MASK) != PORT_CLASS_mISDN)
1940 integer = e_callerinfo.isdn_port;
1943 case MATCH_INTERFACE:
1944 if (!e_callerinfo.interface[0])
1946 string = e_callerinfo.interface;
1947 goto match_string_prefix;
1949 case MATCH_CALLERID:
1951 goto match_string_prefix;
1953 case MATCH_CALLERID2:
1955 goto match_string_prefix;
1957 case MATCH_EXTENSION:
1958 string = e_ext.number;
1962 string = e_dialinginfo.id;
1963 goto match_string_prefix;
1975 case MATCH_ANONYMOUS:
1976 if (e_callerinfo.present != INFO_PRESENT_ALLOWED)
1981 if (e_callerinfo.present == INFO_PRESENT_ALLOWED)
1986 if (e_callerinfo.present == INFO_PRESENT_NOTAVAIL)
1990 case MATCH_AVAILABLE:
1991 if (e_callerinfo.present != INFO_PRESENT_NOTAVAIL)
1996 if (e_callerinfo.screen == INFO_SCREEN_USER)
2001 if (e_callerinfo.screen != INFO_SCREEN_USER)
2005 case MATCH_REDIRECTED:
2006 if (e_redirinfo.ntype != INFO_NTYPE_NOTPRESENT)
2011 if (e_redirinfo.ntype == INFO_NTYPE_NOTPRESENT)
2017 goto match_string_prefix;
2021 now_tm = localtime(&now);
2022 integer = now_tm->tm_hour*100 + now_tm->tm_min;
2027 now_tm = localtime(&now);
2028 integer = now_tm->tm_mday;
2033 now_tm = localtime(&now);
2034 integer = now_tm->tm_mon+1;
2039 now_tm = localtime(&now);
2040 integer = now_tm->tm_year + 1900;
2045 now_tm = localtime(&now);
2046 integer = now_tm->tm_wday;
2047 integer = integer?integer:7; /* correct sunday */
2050 case MATCH_CAPABILITY:
2051 integer = e_capainfo.bearer_capa;
2054 case MATCH_INFOLAYER1:
2055 integer = e_capainfo.bearer_info1;
2059 integer = e_capainfo.hlc;
2063 tfp = fopen(cond->string_value, "r");
2067 if (fgetc(tfp) == '1')
2074 argv[j++] = (char *)"/bin/sh";
2075 argv[j++] = (char *)"-c";
2076 argv[j++] = cond->string_value;
2077 argv[j++] = cond->string_value;
2078 argv[j++] = e_extdialing;
2079 argv[j++] = (char *)numberrize_callerinfo(e_callerinfo.id, e_callerinfo.ntype, options.national, options.international);
2080 argv[j++] = e_callerinfo.extension;
2081 argv[j++] = e_callerinfo.name;
2082 SPRINT(isdn_port, "%d", e_callerinfo.isdn_port);
2083 argv[j++] = isdn_port;
2084 argv[j++] = e_callerinfo.imsi;
2085 argv[j++] = NULL; /* check also number of args above */
2086 if (execve("/bin/sh", argv, environ) == 0)
2097 gettimeofday(¤t_time, NULL);
2098 now_ll = current_time.tv_sec * MICRO_SECONDS + current_time.tv_usec;
2100 timeout = now_ll + (cond->integer_value * MICRO_SECONDS);
2106 if (!(comp_len = (unsigned long)strchr(cond->string_value, ':')))
2108 comp_len = comp_len-(unsigned long)cond->string_value;
2110 mISDNport = mISDNport_first;
2112 if (mISDNport->ifport)
2113 if (strlen(mISDNport->ifport->interface->name) == comp_len)
2114 if (!strncasecmp(mISDNport->ifport->interface->name, cond->string_value, comp_len))
2115 if (!mISDNport->l2hold || mISDNport->l2link>0) {
2117 jj = mISDNport->b_num;
2120 if (mISDNport->b_state[j])
2125 mISDNport = mISDNport->next;
2127 if (cond->match == MATCH_FREE) {
2128 if (avail >= atoi(cond->string_value + comp_len + 1))
2131 if (avail < atoi(cond->string_value + comp_len + 1))
2138 mISDNport = mISDNport_first;
2140 if (mISDNport->ifport)
2141 if (!strcasecmp(mISDNport->ifport->interface->name, cond->string_value))
2142 if (!mISDNport->l2hold || mISDNport->l2link>0)
2144 mISDNport = mISDNport->next;
2146 if (!mISDNport) /* all down */
2151 mISDNport = mISDNport_first;
2153 if (mISDNport->ifport)
2154 if (!strcasecmp(mISDNport->ifport->interface->name, cond->string_value))
2155 if (!mISDNport->l2hold || mISDNport->l2link>0)
2158 mISDNport = mISDNport->next;
2160 if (mISDNport) /* one link at least */
2167 mISDNport = mISDNport_first;
2169 if (mISDNport->ifport)
2170 if (!strcasecmp(mISDNport->ifport->interface->name, cond->string_value))
2171 if (mISDNport->use) /* break if in use */
2173 mISDNport = mISDNport->next;
2175 if (mISDNport && cond->match==MATCH_BUSY)
2177 if (!mISDNport && cond->match==MATCH_IDLE)
2182 case MATCH_NOTREMOTE:
2183 admin = admin_first;
2185 if (admin->remote_name[0] && !strcmp(cond->string_value, admin->remote_name))
2187 admin = admin->next;
2189 if (admin && cond->match==MATCH_REMOTE)
2191 if (!admin && cond->match==MATCH_NOTREMOTE)
2196 PERROR("Software error: MATCH_* %d not parsed in function '%s'", cond->match, __FUNCTION__);
2200 if (cond->value_type == VALUE_TYPE_INTEGER) {
2201 if (integer != cond->integer_value)
2206 if (cond->value_type == VALUE_TYPE_INTEGER_RANGE) {
2207 /* check if negative range (2100 - 700 o'clock) */
2208 if (cond->integer_value > cond->integer_value_to) {
2209 if (integer>=cond->integer_value && integer<=cond->integer_value_to)
2213 /* range is positive */
2214 if (integer>=cond->integer_value && integer<=cond->integer_value_to)
2221 if (strlen(cond->string_value) != strlen(string))
2224 match_string_prefix:
2225 comp_len = strlen(cond->string_value); /* because we must reach value's length */
2226 /* we must have greater or equal length to values */
2227 if ((unsigned long)strlen(string) < comp_len) {
2228 /* special case for unfinished dialing */
2229 if (cond->match == MATCH_DIALING) {
2230 couldbetrue = 1; /* could match */
2231 comp_len = strlen(string);
2236 /* on single string match */
2237 if (cond->value_type == VALUE_TYPE_STRING) {
2238 if (!strncmp(string, cond->string_value, comp_len)) {
2240 /* must be set for changing 'e_extdialing' */
2241 if (cond->match == MATCH_DIALING)
2242 dialing_required = comp_len;
2247 /* on range match */
2248 if (cond->value_type == VALUE_TYPE_STRING_RANGE) {
2249 /* check if negative range ("55"-"22") */
2250 if (cond->comp_string > 0) {
2251 if (strncmp(string, cond->string_value, comp_len) >= 0) {
2253 /* must be set for changing 'e_extdialing' */
2254 if (cond->match == MATCH_DIALING)
2255 dialing_required = comp_len;
2258 if (strncmp(string, cond->string_value_to, comp_len) <= 0) {
2259 /* must be set for changing 'e_extdialing' */
2261 if (cond->match == MATCH_DIALING)
2262 dialing_required = comp_len;
2267 /* range is positive */
2268 if (strncmp(string, cond->string_value, comp_len) < 0)
2270 if (strncmp(string, cond->string_value_to, comp_len) > 0)
2273 if (cond->match == MATCH_DIALING)
2274 dialing_required = comp_len;
2280 /* set current condition */
2281 if (istrue && !couldbetrue)
2282 condition = 1; /* element matches, so condition matches */
2283 if (istrue && couldbetrue && !condition)
2284 condition = 2; /* element could match and other elements don't match, so condition could match */
2286 /* if not matching or could match */
2287 if (condition != 1) {
2288 /* if we have more values to check */
2289 if (cond->value_extension && cond->next) {
2291 goto checkextension;
2297 /* skip exteded values, beacuse we already have one matching value */
2298 while(cond->value_extension && cond->next)
2303 if (timeout>now_ll && match==1) /* the matching rule with timeout in the future */
2304 if (match_timeout == 0 || timeout < match_timeout) { /* first timeout or lower */
2305 /* set timeout in the furture */
2306 match_timeout = timeout;
2307 e_match_to_action = rule->action_first;
2308 e_match_to_extdialing = e_dialinginfo.id + dialing_required;
2309 match = 0; /* matches in the future */
2312 /* matching, we return first action */
2313 action = rule->action_first;
2314 match_timeout = 0; /* no timeout */
2315 e_match_to_action = NULL;
2316 e_extdialing = e_dialinginfo.id + dialing_required;
2320 /* rule could match if more is dialed */
2325 if (match_timeout == 0)
2326 unsched_timer(&e_match_timeout); /* no timeout */
2328 schedule_timer(&e_match_timeout, match_timeout / 1000000, match_timeout % 1000000);
2334 * parses the current action's parameters and return them
2336 struct route_param *EndpointAppPBX::routeparam(struct route_action *action, unsigned long long id)
2338 struct route_param *param = action->param_first;
2341 if (param->id == id)
2343 param = param->next;
2350 * internal rules that are not defined by route.conf
2352 struct route_action action_password = {
2360 struct route_action action_password_write = {
2363 ACTION_PASSWORD_WRITE,
2368 struct route_action action_external = {
2376 struct route_action action_internal = {
2384 struct route_action action_remote = {
2392 struct route_action action_vbox = {
2400 struct route_action action_partyline = {
2408 struct route_action action_disconnect = {